Правильно ли я комментирую код?
В зависимости от того, для чего нужны комментарии, их условно делят на два вида:
Поясняющие логику кода и документирующие — обязательные комментарии, содержащие информацию о назначении объектов, входных и выходных параметрах, данные о разработчике и других важных вещах, относящихся к фрагменту кода.
Но независимо от вида комментариев, стоит придерживаться следующих правил:
1. Комментарии помещаются прямо над кодом, к которому они относятся. Так проще понять, о чём речь, не вникая в содержание каждой строчки.
2. Комментируют все основные элементы кода: модули, функции, константы, глобальные переменные, интерфейсы, классы и их составные элементы
3. Пишут коротко и по делу. Комментарии без смысловой нагрузки страшно раздражают. Пожалуй, этот пункт самый важный, используйте комментарии только тогда, когда они действительно нужны, ведь при всей своей пользе, иногда комментарии в коде — зло.
