Перейти из форума на сайт.

НовостиФайловые архивы
ПоискАктивные темыТоп лист
ПравилаКто в on-line?
Вход Забыли пароль? Первый раз на этом сайте? Регистрация
Компьютерный форум Ru.Board » Компьютеры » Прикладное программирование » Комментирование кода

Модерирует : ShIvADeSt

 Версия для печати • ПодписатьсяДобавить в закладки
Страницы: 1 2 3

Открыть новую тему     Написать ответ в эту тему

maxsv2



Junior Member
Редактировать | Профиль | Сообщение | Цитировать | Сообщить модератору

Цитата:
 
Кто как комментирует свой код, что пишете в комментариях?  
Используете ли ПО для генерации документации из комментариев?  
 

 
Если код не на час/день и для команды -  комменты обязательны.
 
В начале модуля/библиотеки - основная суть  
В начале класса - зачем класс
Перед методом - для чего он нужен
Внутри кода только при каких-то хитростях алгоритма.
 
Правила оформления обычно определяются внутри команды.
 
Пробовали генерить доку на основании коменнтов - не при прижилось.
Дока нужна если нет доступа к исходникам.
Для крупных проектов получается еще что-то монстроидальное, аналогичное копии самого проекта.

Всего записей: 191 | Зарегистр. 24-01-2004 | Отправлено: 15:59 29-04-2017
aseyeff



Full Member
Редактировать | Профиль | Сообщение | ICQ | Цитировать | Сообщить модератору
maxsv2
В целом согласен, особенно Ваши пункты хорошо ложаться на Java и C#
С другими языками могут быть определенные нюансы.
Для автоматической генерации доков по комментам, я использую Doc-O-Matic - очень качественный продукт.

Всего записей: 495 | Зарегистр. 04-02-2003 | Отправлено: 13:28 12-06-2017
landy



Full Member
Редактировать | Профиль | Сообщение | Цитировать | Сообщить модератору
программистам не нужна отдельная документация, которая полностью повторяет комменты, а менеджеры и пользователи никакую доку принципиально никогда не читают. Тогда смысл?

Всего записей: 576 | Зарегистр. 17-01-2003 | Отправлено: 10:26 13-06-2017
asutp2

Advanced Member
Редактировать | Профиль | Сообщение | Цитировать | Сообщить модератору
Для документирования Delphi-кода использую Documentation Insight, с его помощью оформляю XML-описания для всех элементов в interface (константы, типы, классы, свойства/методы классов с описанием каждого параметра метода и т.д.). В implementation комменты пишу только к блокам кода и отдельным ключевым строкам, чтобы суть алгоритма была понятна однозначно и желательно сразу, но при этом чтобы не быть "капитаном очевидность"
 
 
 

Всего записей: 785 | Зарегистр. 22-10-2004 | Отправлено: 16:53 13-06-2017
Открыть новую тему     Написать ответ в эту тему

Страницы: 1 2 3

Компьютерный форум Ru.Board » Компьютеры » Прикладное программирование » Комментирование кода


Реклама на форуме Ru.Board.

Powered by Ikonboard "v2.1.7b" © 2000 Ikonboard.com
Modified by Ru.B0ard
© Ru.B0ard 2000-2024

BitCoin: 1NGG1chHtUvrtEqjeerQCKDMUi6S6CG4iC

Рейтинг.ru