Простая и удобная штука этот PasDoc! Собирает комментарии из юнитов, раскладывает их по объектам, методам, свойствам и превращает это в HTML документ, примерно таким образом
Да, эта штука не вставляет информацию в справку Delphi, и по нажатию на F1 мы не получим описания метода или объекта, но как альтернатива Document Insight – вполне достойный вариант.
На выходе у нас будет HTML документ.
К тому же PasDoc распространяется практически бесплатно, по лицензии GNU. На момент скачивания мной, это была 0.14.0 версия. Исходники прилагаются разработчиком.
Откуда скачать?
На официальной страцние указана ссылка на sourceforge
https://sourceforge.net/projects/pasdoc/files/
После скачивания у нас будет возможность работать с консолью и GUI – кому что по душе.
GUI выглядит таким образом
Как использовать?
Принцип комментирования очень простой, вообще всё написано в документации, но всё же, упомяну здесь основные моменты. Над любым объектом, методом, свойством, которое мы хотим задокументировать можно написать комментарий в фигурных скобках, либо через две косые черты вправо, и он окажется в выходном документе HTML
Комментирование сверху
|
1 2 3 4 |
... { Description of MyVariable. } MyVariable: Integer; ... |
Комментирование снизу
|
1 2 |
MyVariable: Integer; {< Description of MyVariable. } |
Кому как удобно. Комментируем объекты, свойства, методы, переменные и так далее. Вот пример из документации
Далее, в SourceFiles добавляем те юниты, которые необходимо задокументировать
Ну и после нажатия на Generate получаем наш задокументированный юнит, который сохранен в OutputDirectory.