06-Kommentarkonventioner.md

6. Kommentarkonventioner

1. Undvik kommentarer
   I möjligaste mån, undvik att skriva kommentarer. Lägg istället energi på att beskriva din intention i namn på metoder, variabler och dela upp kod på ett förståeligt sätt.

   • Why You Shouldn't Comment (or Document) Code
   • Comments in Clean Code? Think Documentation
   • Don’t document your code. Code your documentation.
   • Fighting Evil in Your Code: Comments on Comments
   • Is There a Correct Way to Comment Your Code?

   Undantag till denna rekommendation:

2. TODO
   Märk kod som behöver förändras med "TODO". Kommentarer skrivs enligt mönstret:
   [//][mellanslag][TODO:][mellanslag][Text som börjar med stor bokstav och slutar med punkt.]

   ℹ EXEMPEL:

   // TODO: En kommentar.

   • SA1005: SingleLineCommentsMustBeginWithSingleSpace

3. Tomma interface-implementationer eller överridningar
   Vid implementation av interface där en eller flera metoder inte behöver användas, skriv en notering om att det görs medvetet. Det gäller även när man överrider en metod vid arv.
   ℹ EXEMPEL:

   public override void DoSomething()
   {
       // Method intentionally left empty.
   }

   • Methods should not be empty

4. Utanför lösningens kontroll
   Använd kommentarer när du behöver förklara skeenden, flöden etc som ligger utanför lösningens kontroll och som inte på ett bra och enkelt sätt kan beskrivas i kod.

5. Vid skapande av API
   Om du skapar ett ASP.NET Web API är dokumentation en del av lösningen. Skriv kommentarer hur man konsumerar de publika metoderna.

   • Creating Help Pages for ASP.NET Web API
   • Swashbuckle - Swagger for WebApi 5.5.3
   • RESTful Web API Help Documentation using Swagger UI and Swashbuckle
   • Show off your API with a little Swagger...

---

◀ Layoutkonventioner | C#-konventioner och checklista ▶