1. Комментируйте "почему", а не "что": Хороший код сам по себе должен быть понятен "что" он делает. Комментарии должны объяснять "почему" сделано именно так, описывать логику, неочевидные решения, допущения или бизнес-правила, которые легли в основу кода.
Плохо: // Присваиваем 10 переменной Переменная = 10; Хорошо: // Согласно бизнес-правилу, начальное значение всегда 10 Переменная = 10;
2. Держите комментарии актуальными: Устаревшие комментарии хуже, чем их отсутствие, так как они могут ввести в заблуждение. При изменении кода обязательно обновляйте и комментарии.
3. Не комментируйте очевидное: Избегайте "шумных" комментариев, которые дублируют очевидный код.
Плохо: // КонецЕсли КонецЕсли;
4. Используйте комментарии для документации: В начале больших процедур, функций или модулей можно оставлять "шапки" с описанием автора, даты создания, назначения, параметров и т. д.
5. Единообразие: Старайтесь придерживаться единого стиля комментирования в рамках проекта или команды.
6. Ясность и краткость: Комментарии должны быть ясными, точными и по возможности лаконичными.
7. Отсутствие русскоязычных символов (иногда): Хотя 1С поддерживает кириллицу в комментариях, некоторые разработчики предпочитают использовать только латиницу в коде и комментариях, особенно в общих модулях, чтобы избежать потенциальных проблем с кодировками при переносе или при работе с внешними системами. Однако в большинстве случаев это не является строгим требованием.
Правильное комментирование значительно улучшает качество кода, делает его более поддерживаемым и снижает затраты на сопровождение в будущем.