2011-07-29 13 views
0

私は自分のコードのドキュメンテーションを作成しようとしていて、xml-commentsを使っています。クラスは次のように文書化されている場合:Tにおけるxml-commentsをビルドするときにVSで型の種類を指定することはできますか?

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

T:

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

xmlファイルには、メインウィンドウのために次のエントリが含まれていますクラス:CaseManager.mainWindowは、それが「タイプである私に指示します、インターフェイス、構造体、列挙型、デリゲート "と残りは私に型の名前空間と名前を教えてくれます。とにかく私はそれがどんなタイプのものなのかを指定することができますか?例えば、クラスのためにT:C:...を書くことによって、インターフェースのためにはT:I:...などとなります。

答えて

1

MSDNによれば、少なくともコンパイラは他のものやそれ以上のものを作成しません。

また、XMLコメント/ソースコード(たとえば<see cref="T:SomeType"/>のような他のものを参照するときなど)にこれらの接頭辞を何らかの形で指定しても、コンパイラReSharperは、サポートされている接頭辞より前の接頭辞。

最後に、のようになりますが、好きなだけ自分でXMLファイルを作成できます。しかし、それは実用的ではないし、他のツール(Sandcastleなど)は、これらのXMLファイルを処理する必要があり、おそらくあなたの規約を理解できないでしょう。

コメントを抽出してドキュメントを作成するための独自のツールセットを作成するのに手間がかかりません。あなたが求めるものを行う方法はないようです。それがすべて許容可能な場合は、Doxygenをチェックアウトしたいかもしれませんが、私はそれがこの点に関して何ができるのか分かりません。

+0

ありがとうございます! - 私はそれを手作業でやっていくつもりだと思う。自動的に行うことができれば、本当に時間を節約することができます。 – Bildsoe

関連する問題