O komentarzach słów kilka

kategoria-komputerowo

Komentarze:

  • bywają pomocne
  • powinny być treściwe, konkretne, ale nie długie
  • unikajmy ich, jeśli możemy napisać czytelniejszy kod
  • powinny wyjaśniać dlaczego zostały użyte takie, a nie inne zapisy, a nie to jak zostały (bo to mamy napisane w kodzie)
  • nie zostawiajmy zakomentowanego kodu – bez słowa komentarza. Skoro kod jest zakomentowany, to najprawdopodobniej jest niepotrzebny. Ponadto – jeśli korzystamy z systemu kontroli wersji, to będziemy w stanie (łatwiej lub trudniej) powrócić do usuniętego martwego kodu
  • powinny być aktualizowane przy okazji zmian kodu którego dotyczą