Учебник по программированию/Как хорошо комментировать?: различия между версиями

Метка: possible spambot (testing)
Метка: possible spambot (testing)
Рассмотрим типы комментариев и начнем с первого - однострочные комментарии. Однострочные комментарии - это комментарии, которые располагаются после какого-то символа или совокупности символов и продолжающихся до конца строки. Мы уже встречались с таким типом комментариев. [[Учебник по программированию|Когда читали параграф VBA / '''Комментарий'''.]]
 
Зачем же нужны однострочные комментарии? В основном такие комментарии используются в том случае, если требуется описать что-либо очень кратко. Это означаетзначит, что комментарий не долженнадо продолжатьсяписать затакие пределамикомментарии, видимогокоторые частичтобы окнапрочитать требовалось использовать полосу прокрутки. Например, вот тут пользователь не поленился и подробно описал код программы:
// создадим наши любимы переменные, со значениями (не очень большими) 23883 и 73773
var a = 23883;
var a = 73773;
И тут мы встретили сразу одну ошибку. Не показалось ли вам, что программист слишком много вставил юмора в комментарии как будто это был не комментарий, а часть книги "Юмор у программистов"? Это выглядит смешно для обычного пользователя и не смешно для программиста, которому для просмотра всего комментария пришлось использовать полосу прокрутки. Я думаю вам понятны ошибки других людей и вы не будете повторять их. Как говориться: "Учусь на чужих ошибках".
 
=== <span style="color:green">'''Многострочные'''</span> ===
Анонимный участник