2

コメントブロックで@remarksと@ingroupを使用していますが、Atomineerを実行すると、削除のマークが付けられたままになり、これを防ぐ方法がわかりません。.XML構成ファイルのルールを変更することを検討しましたが、明らかに何かが欠けています。

Atomineerで処理する前の例：

//-------------------------------------------------------------------------------------
/// @copydoc interface_Result
///          
/// @ingroup platform_implementation module_core
//-------------------------------------------------------------------------------------

Atomineerで処理した後の例：

//------------------------------------------------------------------------------------
/// @copydoc interface_Result.
///
/// ### ingroup platform_implementation module_core.
//------------------------------------------------------------------------------------

ドキュメントには次のように書かれています。「DoxygenまたはDocXMLテンプレートを設定して、新しいコメント形式の「正当な」エントリと、新しいコメントブロック内での順序付け方法を示します。古い形式と新しい形式の両方で同じタグを持つエントリ。 （例：param-> param）は自動的に「変換」されます（新しいスタイルで再フォーマットされます）。AtomineerUtilsによって「合法」と見なされないエントリは、###プレフィックスが付いた「削除済み」としてマークされます。

何かアドバイスやアイデアをいただければ幸いです。これをやめるには本当に必要です。

ありがとう！

4

1 に答える 1

5

（私はAtomineer Pro Documentationの作者です）

Visual Studioでは、

  • [ツール]>[Atomineer]>[Atomineerオプション...]に移動します。
  • [高度なカスタマイズ]タブに切り替えます
  • BlockTemplates-Doxygenボタンをクリック します。

カスタマイズできるテンプレートを含むエディター（メモ帳）が開きます。

テンプレートはXMLベースであり、Atomineerに指示します。

  • どのエントリが合法か（必須またはオプション）。言及されていないエントリは「違法」と見なされ、見つけたとおりに削除されます。
  • コメントが生成/更新されるときにエントリがソートされる順序
  • コメントブロックに追加の空白（空白行）を配置する場所
  • エントリごとに句読点の修正を有効/無効にする必要があるかどうかなど、他のいくつかのこと

Atomineerが文書化できるさまざまなタイプのコード要素ごとにテンプレートがあるため、文書のすべての部分がどのように見えるかを正確に制御できますが、新しい要素をコピーして各要素に貼り付ける必要があります。テンプレート。

たとえば、Doxygenメソッドコメントのデフォルトテンプレートは次のとおりです。

    <method>
        <prototype _punctuate="false" />
        <_ />
        <summary />
        <_ />
        <author _punctuate="false">%user%</author>
        <date _punctuate="false">%date%</date>
        <_ />
        <exception />
        <_ />
        <param />
        <_ />
        <returns />
        <_ />
        <sa _punctuate="false" _optional="true" />
    </method>

この中の各XML要素（行）は、コメント内の1つのエントリを記述します。たとえば、XMLタグは、エントリが最後のコメントブロックの<param/>どこに配置されるかに対応します。@param特別な要素<_/>は、空白行を挿入する場所を示すために使用されます。（プロトタイプは特別なdoxygenであり、プロトタイプ/宣言@ fn、@ classなどを挿入する場所を示します）

Atomineerのコメントを許可@ingroupし@remarksて挿入するには、次のように、コメントに表示する位置にエントリを追加します。

    <method>
        <prototype _punctuate="false" />
        <ingroup _optional="true" /> 
        <_ />
        <summary />
        <_ />
        <remarks _optional="true" />
        <_ />
        <author _punctuate="false">%user%</author>
        ...
    </method>

追加したサンプル要素に属性が含まれていることがわかり_optional="true"ます。これがないと、Atomineerはすべてのコメントにエントリを追加します（必須エントリ）。に設定されている場合true、エントリはAtomineerによって追加されませんが、自分で入力した場合、Atomineerは、ドキュメントコメントを更新するときに必ず保存します。

ご迷惑をおかけしましたことをお詫び申し上げますが、数分のセットアップが必要な場合もありますが、誰もが欲しいものを手に入れることができる柔軟なシステムです。時間があるときはいつでも、このプロセスを簡単にするために改善された構成ツールとチュートリアルを書いています。ただし、一度構成すると、何年も前に幸せになるはずです;-)

テンプレートに関するその他のドキュメントや、テンプレートで実行できるその他のことについては、こちらをご覧ください。

ご不明な点がございましたら、AtomineerWebサイトのすべてのページの下部にあるサポートメールにご遠慮なくお問い合わせください。いつでも喜んでお手伝いさせていただきます。

于 2012-06-21T20:24:09.483 に答える