扩展类文档和实时模板

Question

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

我已阅读 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 Professional。

Answer 1

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

Answer 2

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

更新

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

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