Question

所以我想记录我的班级＆＃39;方法，以便它可以与Help Insight一起使用。然后我发现了XML文档，所以我尝试使用它，但无论出于何种原因它都不适合我。

然后我尝试制作一些更简单的项目，而不是将此文档添加到现有项目中，并且它运行良好，因此通过实验我发现它是因为我的类是通用的。有谁知道如何解决它？我的意思是......它并不重要，但将代码记录在工作的帮助洞察中会很好...

我添加了一个我已经制作的示例项目的代码

interface
  type
   whatever = class
     public
     /// <summary> Remoified item from the collection </summary>
     /// <param name="Item">The item  remove </param>
     /// <param name="Collection"> item </param>
     /// <remarks> If parameter "Item" an exception is raised.
     /// <see cref="EArgumentNilException"/> </remarks>
     /// <returns> False is returned. </returns>
     function test(Item: Pointer; Collection: Pointer): Boolean;
   end;

   whatever<e> = class
     public
     /// <summary> from the collection </summary>
     /// <param name="Item">Te </param>
     /// <param name="Collection"> item </param>
     /// <remarks> an exception is raised.
     /// <see cref="EArgumentNilException"/> </remarks>
     /// <returns> False . </returns>
     function test(Item: Pointer; Collection: Pointer): Boolean;
   end;

  /// <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 test(Item: Pointer; Collection: Pointer): Boolean;
implementation
...

如您所见，我甚至使用了

中的示例注释

http://docwiki.embarcadero.com/RADStudio/Berlin/en/XML_Documentation_Comments

适用于＆＃34;无论什么＆＃34;等级和单位方法，但它不适用于

whatever<e> = class

我正在从其他单位进行测试：

var
we:whatever;
wee:whatever<integer>;
begin
  try
    test();
    we.test();
    wee.test();
  except
    on E: Exception do
      Writeln(E.ClassName, ': ', E.Message);
  end;
end.

我知道这不会编译，但这只是一个观点。 Insight帮助显示有关test（）的请求文档;和we.test（）;但是在wee.test上它只显示标准＆＃34;在......＆＃34;

中声明

顺便说一下。在定义方法的类中，洞察力帮助很好（我的意思是，如果我将鼠标悬停在

上）

fuction whatever<E>.test(Item, Collection : Pointer) : boolean;

它会向我显示所要求的文件，但它不会在外面工作。

我也尝试为类型添加文档，但这对我没有帮助。我不想要任何代码解决方法，我必须添加方法才能使其工作（但随意发布它们可以帮助其他人）我只是想知道我是否在做某事错误或我必须设置一些内容，或者它是否只适用于泛型类。

Edit1：我怀疑RAD工作室在用类型定义它时并不认为它是同一个类（真正奇怪的是你使用泛型的方式......我猜）。

也请原谅我奇怪的格式化我只是赢了让我用＆gt;和＆lt;在正常文本中，因为它用于链接

RAD Studio 10.1柏林更新2 - 刚刚发现它可以提供帮助

delphi用于泛型类的XML文档

0 个答案: