0

コードのドキュメントを作成しようとしていますが、xml-commentsを使用しています。クラスが次のように文書化されている場合：

/// <summary>
/// Main presentation window
/// </summary>
public partial class mainWindow : Form
{
}

xmlファイルには、mainWindowの次のエントリが含まれます。

<member name="T:CaseManager.mainWindow">
        <summary>
        Main presentation window
        </summary>
    </member>

T：CaseManager.mainWindowのTは、「タイプ：クラス、インターフェイス、構造体、列挙型、デリゲート」であることを示し、残りはタイプの名前空間と名前を示します。とにかくタイプを指定させる方法はありますか？たとえば、クラスの場合はT：C：...、インターフェイスの場合はT：I：...などと記述します。

4

1 に答える 1

1

MSDNによると、少なくともコンパイラは他の何かやより具体的なものを作成しません。

また、XMLコメント/ソースコードでこれらのプレフィックスをなんとか指定できたとしても（たとえば、他のものを参照する場合など、いくつかの場所で可能です<see cref="T:SomeType"/>）、コンパイラ、ReSharper、およびサポートされているプレフィックス以外のプレフィックスについて文句を言うことはありません。 。

最後に、必要に応じて、すべて自分でXMLファイルを作成できます。ただし、これはもちろん実用的ではなく、これらのXMLファイルを処理するSandcastleのような他のツールも、おそらくあなたの慣習を理解しないでしょう。

したがって、コメントを抽出してそこからドキュメントを作成するための独自のツールセットを作成する以外に、あなたが求めることを行う方法はないようです。それがまったく許容できるのであれば、doxygenをチェックアウトすることをお勧めしますが、この点で何ができるのかわかりません。

于 2011-07-29T09:42:35.550 に答える