Kommentarer

Kod skrivs och underhålls av människor. Försäkra dig om att din kod är tydlig, väl kommenterad och tillgänglig för andra. Bra kommentarer beskriver övergripande sammanhang eller syfte. Kommentera i fullständiga meningar för större kommentarer och kortfattade fraser för allmänna anteckningar.

  • Placera kommentering på ny rad ovan den kod den angår
  • Tänk på läsbarheten, skriv ej för långa rader, max 80 tecken är en bra riktlinje
  • Kommentera ofta för att bryta upp css-koden i mindre överskådliga sektioner
  • Använd konsekvent indentering och konventionella skrivregler

Kommentera formaterat enligt Idomatic CSS. Tips är att använda plugins ( Sublime, Atom) för din editor för att upprätthålla en standard för kommentarer.

Bas-kommentar

/* Kommentar */

Sub-kommentar

/*
Kommentar
==========================================================================
*/

TODO-kommentar

/*

/**
  @TODO
*/

Sektions-kommentar

/* 
==========================================================================
Kommentar
==========================================================================
*/

Lång kommentar

/*
  Kommentar
*/