4

我正在使用代码文档和实时模板，但我完全不明白。

我读过Dr.Bob 的关于生成文档的文章和关于实时模板的 wiki 文章，但我对类描述有一个问题。

通过类描述，当我将鼠标光标指向类声明时，我了解 IDE 行为。

例如，我有这样的类，它的描述是：

type
  {$REGION 'TMyClass'}
    /// <summary>
    /// Summary works
    /// </summary>
    /// <remarks>
    /// Remarks works
    /// </remarks>
    /// <exception cref="www.some.link">This works</exception>
    /// <list type="bullet">
    /// <item>
    /// <description>description does not work</description>
    /// </item>
    /// <item>
    /// <description>description does not work</description>
    /// </item>
    /// </list>
    /// <permission cref="www.some.link">This works</permission>
    /// <example>
    /// <code>
    /// Code example does not work
    /// </code>
    /// </example>
  {$ENDREGION}
  TMyClass = class
  private
    a, b, c: Integer;
  public
  end;

后来在代码中我有这样的声明：

var
  MyObject: TMyClass;

当我将鼠标光标放在类类型上时，我有这样的描述：

类描述

如您所见，并非每个 html 标记都由 IDE 引擎呈现。我真的很想知道如何呈现其他标签，尤其是带有代码示例的标签。是否可以？

我正在使用 Delphi 2009 Proffesional。

4

2 回答 2

8

仅支持有限的标签集。我所知道的关于这些东西的最佳文档是 DevJET Software 的Delphi 文档指南（在“目录”的末尾有指向 PDF 的链接）。

于 2011-09-25T19:35:16.083 回答
3

Help Insight 支持的标签在在线帮助和Delphi docwiki中有描述。它们是 C# 的帮助标签支持的标签的子集。除了 Embarcadero 网站上列出的标签之外，似乎不支持其他标签（我已经尝试过）。其他唯一有效（并且是必需的）是“<”、“>” 和“”。

更新

似乎有一些产品允许您使用完整的语法，例如由@ain 链接的 Delphi 文档指南中所述。但这需要您购买像 DevJet 的Documentation Insight这样的商业产品，不应将其与自 Delphi 2006 以来 IDE 支持的Help Insight混淆。

正如您发现的那样，我也发现了，只有Delphi docwiki中描述的子集由没有商业产品的裸 IDE 支持。建模接口也支持文档，但又有所不同。在普通的 IDE 中，您只能使用您和我已经找到的标签。

于 2011-09-25T23:11:26.863 回答