Документация по коду для Delphi похожа на Javadoc или C # XML документ

Question

Мне нужен инструмент документирования кода, похожий на javadoc или c # xml doc для кода delphi. Какой самый лучший инструмент? Я предпочитаю технологию, которая в будущем будет совместима с проектом Microsoft Sandcastle.

Answer 1

Взгляните на SynProject , инструмент с открытым исходным кодом, написанный на Delphi.

Он был разработан для обработки полного рабочего процесса документации, от спецификаций до примечаний к выпуску, включая тесты, архитектуру и дизайн; и, конечно, есть встроенный анализатор Delphi для генерации документации по архитектуре из существующего исходного кода Delphi.

Для документа архитектуры исходный код может извлекать комментарии (например, PasDoc), а затем встраивать этот текст в основной документ архитектуры (с диаграммами иерархии классов и зависимостями модулей).

Вы пишете простой текстовый файл с использованием вики-подобного синтаксиса в специальном текстовом редакторе, а затем SynProject создает из него хорошо отформатированные документы Word. Некоторые мастера доступны для доступа к контенту. Но поскольку он хранится в виде простого файла, на него могут писать несколько программистов, используя любой инструмент SCM (SVN, Fossil ...).

Например, в настоящее время я использую его для написания документации по обслуживанию огромного и старого приложения Delphi (около 2 000 000 строк кода, написанных в Delphi 5 и 6), без ранее доступной документации. Вы описываете изменения, внесенные в код (цитируя единицу / класс / метод), затем инструмент обновит всю документацию, чтобы отразить и отследить эти изменения. SynProject был разработан, чтобы соответствовать некоторым очень «деликатным» правилам регулирования (IEC 62304), но может использоваться для любого проекта благодаря своей уникальной «плоской» конструкции.

Примечание : я отправляю это через много времени после вопроса, потому что SynProject в то время еще не существовал, и его стоит посмотреть. Эта тема была определена как ссылка на этот вопрос .

Answer 2

Try: - Doxygen документация - Pas2Dox

Answer 3

Насколько мне известно, не существует инструмента, легко совместимого с Microsoft Sandcastle - по крайней мере, до тех пор, пока кто-то действительно не потрудится написать его, модифицировать существующий или создать цепочку инструментов для правильного преобразования вывода.

Я лично использовал PasDoc с большим успехом. Я рекомендую создавать последнюю версию SVN, поскольку текущая версия время от времени ломается от сложных определений интерфейса.

Answer 4

Delphi + JavaDoc = DelphiCodeToDoc

Answer 5

Начиная с Delphi 2005, он встроен в компилятор Delphi. Он использует стандарт XMLDoc, который использует комментарии в стиле XML. Как и C #, думаю, Sandcastle справится с этим. См http://dn.codegear.com/article/32770 и http://tondrej.blogspot.com/2006/03/xml-documentation-in-delphi-2006.html

Также см. Документирование Delphi

Answer 6

Вопрос довольно старый, но у меня была такая же проблема сегодня, и я нашел этот пост. Delphi 2007 допускает следующий синтаксис, который, кажется, равен документации C #:

/// <summary>
/// Summary of the function / class
/// </summary>
/// <param name="param1">Description of the parameter param1</param>
/// <param name="param2">Description of the parameter param2</param>
/// <param name="param3">Description of the parameter param3</param>
/// <returns>Description of the return value</returns>
function test(param1, param2, param3: string): string;

Для <summary> не представляется возможным разрешить разрывы строк. <br /> не работает.

Answer 7

DelphiCodeToDoc также имеет командную строку для использования его с инструментом непрерывной интеграции (например).

Answer 8

Sandcastle должен получить доступ к сборкам, чтобы сгенерировать свою документацию, что означает, что она применима только для языков .net (хотя я не уверен, что умеет Delphi.Net). Тем не менее, Delphi 2007 и 2009 имеет встроенную XML-документацию, очень похожую на C #. Когда вы включаете опцию «Генерировать документацию XML» в опциях проекта, она будет создавать документацию XML на основе этих комментариев. Затем XSLT можно использовать для создания любого необходимого формата документации (это сложный бит).