Komentarze w HTML (dobre praktyki)

" W programowaniu komentarze są najczęściej używane, aby wyjaśnić pewien fragment kodu. Musisz mieć jednak świadomość, iż należy ich UNIKAĆ. Obecność komentarzy ZAWSZE sygnalizuje nieporadność programisty. Kod powinien być napisany tak, aby nie wymagał komentarzy, chociaż są również małe wyjątki od tej reguły."

Nie chcę się czepiać, ale wydaje mi się, że jest zupełnie odwrotnie, że wręcz powinno się używać komentarzy.
Do tej pory miałam do czynienie z programowaniem głównie w C++ i zachęcano mnie do pisania komentarzy. Dlaczego? Dlatego, że mój kod może być czytany przez inną osobę (najczęściej tak jest w pracy), która może nie do końca wiedzieć o co mi chodziło w danym fragmencie kodu.
Może jeśli chodzi o HTML jest zupełnie inaczej. Nie wiem, ale chętnie się dowiem.

Magda

Cześć Magda, od Twojego posta minęło już trochę czasu ale mam nadzieję, że odpowiedź jeszcze Ci się przyda.

Według mnie komentarze kiedyś były pożądane i były pewnego rodzaju dobrą praktyką. Jeśli uczyłaś się programować w szkole lub na studiach, to tam najprawdopodobniej byłaś zachęcana do pisania komentarzy. Ja na studiach spotkałem się nawet z następującym stwierdzeniem prowadzącego zajęcia "Jesteście programistami, więc o konieczności dokładnego komentowania kodu nawet nie muszę wspominać".

W prawdziwej pracy programisty sprawa wygląda jednak inaczej. Ja w pracy używam języka Ruby i JavaScript. Gdybym pisał dokładne komentarze w kodzie, to bym chyba został wyśmiany przez zespół. Kod który piszę powinien być "samokomentujący", czyli napisany na tyle dobrze i czytelnie, że nie trzeba do niego dodawać komentarzy. Można to osiągnąć poprzez pisanie krótkich funkcji, których nazwy dobrze opisują to, co dany fragment robi oraz dobre nazywanie zmiennych. Wadą komentarzy jest głównie to, że wymagają dodatkowej pracy oraz szybko ulegają "przeterminowaniu". Często zdarzy się, że w dobrze okomentowanym kodzie ktoś zmieni fragment kodu i nie dostosuje do tego komentarzy. W takiej sytuacji wprowadzają one tylko w błąd innych programistów. Komentarzy warto używać gdy piszemy coś bardzo niestandardowego, co warto opisać.

Według mnie są jednak języki programowania, w których dobre komentarze są niezbędne, np. w assemblerze chyba bardzo ciężko bez nich żyć. Natomiast w językach takich jak Ruby, JS, czy w HTML raczej warto ich unikać.

Polecam Ci popularną książkę "Czysty Kod", w której autor poświęca jeden z rozdziałów na omówienie dobrych praktyk związanych z komentarzami. Znajduje się też tam wiele innych dobrych praktyk, więc warto przeczytać :)