delphi - 在 Delphi 中注释方法？

Question

我有一段代码需要一些认真的文档记录，并且想询问 Embarcadero Delphi 是否可以使用类似于 C#/.NET 的代码内 XML 文档的功能。我的目标是显示某种关于如何正确使用特定方法的信息，其方式将在 Delphi XE3 的自动完成中突出显示。

类似这样的东西(C#):

/// <summary>
/// Some useful information helping other developers use this method correctly
/// </summary>
public static void ADocumentedMethod();

Delphi XE3支持这样的东西吗？

感谢您的阅读。

Answer 1

该功能名为 XML 文档注释，编号为 documented here 。它似乎是根据等效的 .net 功能紧密建模的，因此您应该熟悉它。

文档包含以下示例:

/// <summary> Removes the specified item from the collection
/// </summary>
/// <param name="Item">The item to remove
/// </param>
/// <param name="Collection">The group containing the item
/// </param>
/// <remarks>
/// If parameter "Item" is null, an exception is raised.
/// <see cref="EArgumentNilException"/>
/// </remarks>
/// <returns>True if the specified item is successfully removed;
/// otherwise False is returned.
/// </returns>
function RemoveItem(Item: Pointer; Collection: Pointer): Boolean;
begin
  // Non-XML DOC comment
  // ...
end;

这会导致此帮助洞察提示:

还有各种其他方法来处理和使用文档。