如何根据源文档注释生成CHM帮助文件？

可能重复：
Code documentation for delphi similar to javadoc or c# xml doc 如何根据源文档注释生成CHM帮助文件？

我一直在使用在大多数我的全球源的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源文档（和大多数其他语言）。

来源

2012-06-09 Jerry Dodge

在副本中执行其他任何解决方案时是否明确使用我在问题中演示的XML文档？或者他们需要完全不同的手段来创建文档？ –

我的观点是，正如问题所述，我已经有大部分源代码使用这种格式 - 这在XE2中似乎有点标准（因为在符号上悬停显示此信息）。我需要能够使用已经存在的内容，并将这一个来源作为唯一来源。在两个不同的地方维护相同的文档是很困难的。 –

就像一个信息点：“.CHM帮助文件”实际上称为“HTML帮助文件”，而“源文档注释”是“XMLDoc”或“XML文档”。 –

这不是一个CHM文件，但如果您使用Delphi Enterprise或更高版本，则IDE使用格式正确的源代码注释ability to produce documentation。

来源

2012-06-10 03:26:07 LachlanG

您是否指的是文档生成功能（建模功能的一部分）我在我的答案@KenWhite中链接了？如果是这样，那么根据XE2功能矩阵它只是企业版和以上（我没有访问Pro来确认，但）。如果您正在讨论的另一个功能可以请您链接到它，因为我有兴趣查看。谢谢。 – LachlanG

其实没有。（我很高兴我没有downvote。）你提供的链接实际上是功能*我*永远不知道存在。我仍然不确定这是杰里寻找的东西（这个问题似乎指的是直接将XMLDoc注释转换为HTML，而XMLDoc支持就是我认为你的答案提到的），但是感谢这些信息。我喜欢学习我不知道的东西。 :-) –

如何根据源文档注释生成CHM帮助文件？

回答

相关问题