0

可能重复：
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（我在不同的 PC 上都看到过），它会打开一个窗口，让事情变得更容易。我在按下Ctrl+Shift+S保存时偶然发现了这个，但不小心击中了D。

我想知道的是如何将此文档导出到 CHM 帮助文件？我想制作一个链接到我的库的帮助文件，以便开发人员可以在代码中使用 F1 并查看代码的作用说明。就像标准的 Delphi 源文档（和大多数其他语言）一样。

4

1 回答 1

2

它不是 CHM 文件，但如果您使用 Delphi Enterprise 或更高版本，IDE能够使用您正确格式化的源代码注释生成文档。

于 2012-06-10T03:26:07.280 回答