4

コード ドキュメントとライブ テンプレートをいじっていますが、よくわかりません。

ドキュメントの生成に関するDr.Bob の記事と、ライブ テンプレートに関する wiki 記事を読みましたが、クラスの説明に 1 つの問題があります。

クラスの説明により、マウスカーソルをクラス宣言に合わせたときの 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 を使用しています。

4

2 に答える 2

8

限られたタグのセットのみがサポートされています。私が知っているこの内容に関する最良のドキュメントは、DevJET ソフトウェアのDelphi ドキュメント ガイドラインです (「目次」の最後に PDF へのリンクがあります)。

于 2011-09-25T19:35:16.083 に答える
3

ヘルプ インサイトがサポートするタグについては、オンライン ヘルプとDelphi docwikiで説明されています。これらは、C# のヘルプ タグがサポートするタグのサブセットです。Embarcadero サイトにリストされているもの以外のタグはサポートされていないようです (試してみました)。他に機能する (そして必要な) ものは、"<"、">" だけです。および「」。

アップデート

たとえば、@ain によってリンクされた Delphi ドキュメント ガイドラインで説明されているように、完全な構文を使用できる製品がいくつかあるようです。ただし、 DevJet のDocumentation Insightなどの商用製品を購入する必要があります。Delphi 2006 以降で IDE がサポートするHelp Insightと混同しないでください。

お気づきのように、私もそうでしたが、 Delphi docwikiに記述されているサブセットのみが、商用製品を含まない裸の IDE でサポートされています。Modeling インターフェイスでサポートされているドキュメントもありますが、これもまた異なります。通常の IDE では、既に見つけたタグしか使用できません。

于 2011-09-25T23:11:26.863 に答える