Комментарии — вещь полезная, но хорошего должно быть в меру
Комментарии нередко становятся одним из типичных признаков плохого кода, написанного беспорядочно. Не ошибусь, если скажу: каждый программист стремится к совершенствованию своих знаний и скилов. Умение писать чистый код — не исключение. Как научиться данному умению? Есть утверждение: чистый код должен читаться легко без всяких комментариев (как простой текст, написанный на английском языке). Если понадобилось добавить комментарий, чаще всего это означает: код недостаточно продуман и не совсем выразителен.
Не стоит пренебрегать длинными именами для переменных, названий классов, функций. Это одна из наиболее часто встречаемых ошибок новичков в программировании. Когда кто-либо взялся за чтение вашего кода, он должен и без комментариев понимать что происходит. Содержимое кода должно грамотно сосуществовать с именами, присвоенными тому или иному типу данных.
Нередко комментарии используются для маскирования косяков. Это типичный случай плохо читаемого кода, когда именно из комментария понятен смысл происходящего. Чтобы этого избежать стоит обратить особое внимание на правильное наименование сущностей.
ТОП 10 в сети и в жизни — это цель нашей работы с Вами и Вашим проектом
CREATIVE24 WEB&IT info@creative24.ru
Техподдержка 24/7