2:35 PM Зачем нужны комментарии |
Комментарии попадаются в любом коде, который мы встречаем. От сложных программ, до простых математических функций. Но я стал замечать, что некоторые мои знакомые используют комментарии не по назначению. А они ведь, по-сути, очень удобная штука. Для того, чтобы верно составлять комментарии, достаточно знать причины, по которым их оставляют. За исключением комментов "Здесь был Вася" или "Яндекс лох" , существует только три типа вопроса, которым отвечают комментарии: 1. Что это значит и что произойдёт? - Краткое описание "стрёмного" куска кода, которое обязательно пригодится, если вдруг придётся как-то на него наткнуться. Облегчает работу в разы, самый популярный тип комментов. Однако иногда люди увлекаются и забивают комментами всё подряд, из-за чего код становится не читабелен. Поэтому искренне не рекомендую вкладывать в уже прокомментированную таким типом комментариев функцию ещё один комент! Иначе провал гарантирован. 2. Почему я сделал именно так? - Бывает, что решений несколько, и от каждого из вариантов не хочется отказываться. В конечном итоге приходится выбирать, однако выбор не всегда верен. Оставьте для себя такую подсказку, чтобы работать "по горячему" если понадобится. 3. Куда эта часть обращается? - Тысячи, десятки тысяч строк. Сквозь них, красной нитью, проходят пять переменных. На строке 3534 идёт обращение в строку 1231, где идёт вызов функции из другого файла. Как понять, что это произошло? Оставьте коммент. |
|
Всего комментариев: 0 | |