Возможный дубликат:
Документация по коду для delphi, аналогичная javadoc или c# xml doc
Я использовал возможности документирования RAD Studio Delphi XE2 в большинстве своих глобальных источников (библиотеки, такие как бизнес-правила, компоненты/элементы управления и т. д.). Это помещает некоторый закомментированный текст непосредственно перед объявлением различных вещей в вашем исходном коде, например:
type
/// <summary>
/// This class is used for this and that.
/// </summary>
TMyObject = class(TObject)
....
или даже
/// <summary>
/// This function does this and that.
/// </summary>
/// <returns>
/// This is the result of what DoSomething produces.
/// </returns>
/// <remarks>
/// DoSomething is only a sample function for demonstration purposes.
/// </remarks>
function DoSomething: String;
Основная причина, по которой я это делаю, заключается в том, что когда вы наводите курсор на символ, когда он показывает понимание, он будет включать в себя этот текст документации. Например, в совершенно отдельном блоке наведите указатель мыши на текст DoSomething
, где бы он ни использовался, и он покажет вам окно подсказки, содержащее точный текст, написанный в этой документации.
Подсказка: нажмите либо Ctrl+Shift+D
, либо Ctrl+Alt+D
(я видел оба на разных ПК), и откроется окно, чтобы упростить задачу. Я наткнулся на это, когда нажимал Ctrl+Shift+S
для сохранения, но случайно нажал D
.
Я хотел бы знать, как я могу экспортировать эту документацию в файл справки CHM? Я хотел бы сделать файл справки, связанный с моей библиотекой, чтобы разработчик мог использовать F1 в коде и видеть объяснение того, что делает код. Так же, как стандартная исходная документация Delphi (и большинство других языков).
HTML Help File
, а комментарии исходной документации -XMLDoc
илиXML documentation
. - person Ken White   schedule 10.06.2012XMLDoc
и если doc-o-matic поддерживаетXMLDoc
, то это было бы идеальным решением: D - person Jerry Dodge   schedule 10.06.2012