扩展类文档和实时模板

Question

我正在使用代码文档和实时模板，但我完全没有得到它。

我已阅读Dr.Bob's article关于生成有关实时模板的文档和维基文章，但我对类描述有一个问题。

通过类描述我理解当我将鼠标光标指向类声明时的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。

Answer 1

仅支持有限的标记集。关于这些东西的最佳文档我知道的是DevJET软件的Delphi Documentation Guidelines（在“目录”的末尾有PDF链接。）

Answer 2

帮助洞察支持的标记在在线帮助和Delphi docwiki中有所描述。它们是C＃帮助标记支持的标记的子集。没有其他标签比Embarcadero网站上列出的标签似乎得到支持（我已经尝试过了）。唯一有效的（并且是必需的）是“＆amp; lt;”，“＆amp; gt;”和“＆amp; quot;”。

更新

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

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