Документирование Delphi

Ответ 1

Я думаю, что лучшим инструментом для документирования delphi является PasDoc.

Помимо предоставления вам HTML или CHM-документа с очень хорошо структурированным индексом всех классов, методов и свойств, которые у вас есть на вашем коде, он допускает такие комментарии кода:

{
@abstract(Concatenate two strings)
@param(AStringA The first string to concatenate)
@param(AStringB The second string to concatenate)
@returns(The concatenated string)
}
function Concatenate(AStringA, AStringB : string) : string;

Здесь у вас есть выходная документация для самого PasDoc., поддерживается теги и страница загрузки. Это также с открытым исходным кодом, и я, очевидно, написал в Delphi

Ответ 2

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

Ответ 3

Да его называется Delphi code to doc, он использует javaDoc, чтобы создать файл справки Windows.

Но для того, чтобы максимально использовать его, вам понадобятся все комментарии функции/процедуры/класса и т.д. в javaDoc, например,

{**
*  @auther your name
*  description your description here
*}

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

EDIT: и его совершенно бесплатно: D

Ответ 4

Другим вариантом будет Pascal Browser (PAB) из http://www.peganza.com/#PAB
Анализатор Pascal от Peganza также стоит посмотреть.

Ответ 5

Справка Scribble имеет неплохую функцию, которая позволяет указывать ее в файле dpr и строит весь файл справки Windows со структурой вашего кода. Он имеет стандартный формат, который можно использовать для обеспечения правильной информации от каждого устройства, класса и функции. Его довольно быстро и эффективно.

Ответ 6

Справка и руководство имеют отличную поддержку документации Delphi. Существует также хороший инструмент захвата экрана и обработки изображений (обрезка/тень и т.д.), Который интегрирован в пакет.

Ответ 7

Место для перехода оттуда, чтобы получить контроль над устаревшим кодом, было бы программной археологией, используя некоторые из встроенных мер и показателей Delphi 2007/2009. Слушайте Введение в археологию программного обеспечения на Повторное воспроизведение CodeRage II.

Ответ 8

Я использую JADD - Just Another DelphiDoc время от времени, потому что его можно быстро использовать для создания диаграмм классов. Но он не поддерживает последнюю версию Delphi. Вот пример очень простой диаграммы.

Ответ 9

Вы также можете попробовать SynProject из Synopse:

http://synopse.info/fossil/wiki?name=SynProject

Это, как представляется, обеспечивает полную документацию/возможности управления, а также синтаксический анализ источника для вывода в html или pdf.