Witam jak komentujecie kod?
Używacie "" czy "/"?
Ja osobiście ostatnio zacząłem używać tylko "///" ponieważ przy okazji daje to opis prz IntellSense w visualu ;p
0
1
Język? Czy mamy zgadywać?
Strzelam że C#:
// używa się do 'tradycyjnych' komentarzy, np.
// usuń wszystkich z bazy danych
/// używa się do dokumentowania funkcji za pomocą XML, takie komentarze lecą do metadanych, np.
///<summary>Nic nie robiąca funkcja</summary>
0
Wyczerpującymi nazwami testów, nie nazywaniem zmiennych a,b,c,(czy w php $a, $$a) itd, czy funkcji w stylu jfgsf.
Lubię sobie też kawałki pozamykać w takim czymś, ale to netbeansowe.
// <editor-fold defaultstate="collapsed" desc="ten kawałek robi to i tamto">
jakiś kod
// </editor-fold>
Imo jak się stosuje konwencje(np funkcje sprawdzające zaczyna się od is, a pobierające od get), i pisze się testy to przeważnie komentarze można sobie zwyczajnie olać, i tylko czasem skrobnąć jakiegoś javadoc(czy jakiś odpowiednik w innych językach).
0
a co z CWEB, by Donald E. Knuth martwa ciekawostka?
a kiedy pytam Wiki o "DEK" proponuje mi jakąś wioszczynę w persii, granda! :-)