Guter, schlechter, hässlicher Kommentar

Warum brauchen wir Kommentare, stimmt es, dass guter Code ohne sie gelesen werden kann und wie Perfektionismus die Entwicklung um das Vierfache verlangsamt. Für Anfänger, Teams, Profis.

Intuitive Bekanntschaft

mit Kommentaren, wie in jeder Beziehung, schafft versteckte Probleme. Aus dem Stackoverflow oder aus unserer Kreativität bilden wir unwissentlich die Art des Kommentierens. Jemand ist zu detailliert, jemand mit Humor, und jemand schreibt im Allgemeinen "ohne Kommentare" und versucht nach einem halben Jahr nicht einmal zu verstehen, wie sein Code funktioniert.

P.S. Wenn Sie die Person sind, die von den Kommentaren im Code aus dem Buch erfahren hat, geben Sie ein Zeichen.) Wenn Sie sofort Antworten benötigen, sind sie am Ende.

- - , "" , . , ... , , .

, . – , "" , .. , .

, , .

–

*. 950 , : " ". : " ", " , ".

, – . ? , , 20 . – -, , . , , " " .

20% , -, 5.

– , . , .

, 20% 80% – , , , . . , 100% "" / " " ( ). == .

, Win – , , , " " , , , . – .

– . , , .

*Code Complete, , 1993. " " " ". – , , "" , , .

.. , , – .

1. "" .

   
   
   
   
   

   1. " " – /. . , (). : .

      
      
      
      
      

   2. – , , . , , .

      
      
      
      
      

   3. – , , , / , TODO (), FIX () .. , , . : , – .

      
      
      
      
      

2. . 10 000 , 3 . – , "", . ( ), .

   
   
   
   
   

3. – , . . .

   
   
   
   
   

4. – , , .

   
   
   
   
   

5. – . - . , , ", ". , , , ... , .

   
   
   
   
   

, !

.. ... .