Использование Doc-O-Matic (Express) с Delphi

Question

Я ищу инструмент для создания документации по исходному коду Delphi, и я хочу попробовать Doc-O-Matic Express (это бесплатно). Существуют ли рекомендации для начинающих, как использовать Doc-O-Matic Express для документирования исходного кода Delphi (управление документами-документами, предпочтительный стиль докблока, полный синтаксис докблока и т. Д.)?

Answer 1

Не беспокойтесь о настройках Doc-o-matic прямо сейчас.Экспресс-версия только для командной строки.

1. Выберите стиль комментария
2. Комментируйте свой код
3. Создайте документацию (проект по умолчаниюдостаточно для начала)
4. Убедитесь, что вы прокомментируете покрытие

Документация поддерживает JavaDoc и XMLDoc (или даже родные комментарии).Сам инструмент поможет только в том случае, если ваш код уже прокомментирован или вы хотите комментировать непосредственно в его IDE.

Если вам нравится XML Doc или JavaDoc, Doc-O-Matic поддерживаети одинаково хорошо, и все три стиля поддерживаются при записи комментариев источника через встроенный редактор обратно к источнику.

Answer 2

На этой странице вы можете найти документ, который будет вам полезен Delphi Documentation Guidelines. Я использовал это руководство для документирования моего исходного кода в этом проекте .