Question

我正在寻找有关摘要标记的Help Insight的解决方案/帮助。我正在使用Delphi Tokyo 10.2 Update 2.

1。）HelpInsight有效且该功能确实有其他信息

interface

type
TMyClass= class(TForm)
   private
/// <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 TClass.TestFunction(Item: Pointer; Collection: Pointer): Boolean;
  end;

2.。）HelpInsight不会添加其他信息

implementation
/// <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 TClass.TestFunction(Item: Pointer; Collection: Pointer): Boolean;
begin
 // Non-XML DOC comment
  // ...
end;

我不喜欢在界面中有摘要XML代码。是否有任何解决方案可以让HelpInsight从实现部分获取摘要？

Answer 1

docs中没有明确说明，但是在实现部分中几乎没有任何提示（粗体）：

查看>帮助洞察 Shift + Ctrl + H
显示包含有关符号的信息的提示，例如类型，文件，声明的位置以及与该符号关联的任何XML文档（如果有）。

Delphi HelpInsight，包含实现摘要

1 个答案: