可能重复:
Code documentation for delphi similar to javadoc or 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
(我已经在不同的PC上看到了这两个),它会打开一个窗口,让事情变得更容易。在按Ctrl+Shift+S
保存但意外点击D
时,我偶然发现了这一点。
我想知道的是如何将此文档导出到CHM帮助文件?我想创建一个链接到我的库的帮助文件,以便开发人员可以在代码中使用F1并查看代码所做的解释。就像标准的Delphi源文档(以及大多数其他语言)一样。
答案 0 :(得分:2)
它不是CHM文件,但如果您使用Delphi Enterprise或更高版本,则IDE使用正确格式化的源代码注释ability to produce documentation。