Кодовая документация для delphi, аналогичная javadoc или c # xml doc

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

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

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

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

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

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

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

Delphi + JavaDoc = DelphiCodeToDoc

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

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

Попробуйте: Doxygen , Pas2Dox

С 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

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

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

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

///  /// Summary of the function / class ///  /// Description of the parameter param1 /// Description of the parameter param2 /// Description of the parameter param3 /// Description of the return value function test(param1, param2, param3: string): string; 

Для

, похоже, нет возможности разрешать разрывы строк.
не работает.

Давайте будем гением компьютера.