6

C＃のXMLドキュメントコメントで、2つ以上の関数を相互にオーバーロードするようにマークして、相互に自動的に参照する方法はありますか？理想的には、それらはサンドキャッスルで生成されたドキュメントにも何らかの形でグループ化されます。

目的：多くの場合、このグループの関数にリンクしたいと思います。たとえば、ユーティリティ関数のリストで、オーバーロードの1つに言及し、そこから他の関数​​を簡単に見つけられるようにします。

現在、リンクを追加していますが、面倒です。

4

2 に答える 2

2

複数のオーバーロード間の関係は、XMlドキュメントとSandcastleによってすでに識別され、グループ化されています。

seeまたはseealsoタグを使用して他のメンバーへのリンクを作成します。

例えば。

///See <see cref="M:AnotherMethod(System.String)">

ただし、Sandcastleメンバーの解決は少し不安定になる可能性があるため、完全修飾名を使用する傾向があります。

///See <see cref="M:MyCompany.Myapp.MyClass.AnotherMethod(System.String)">

M：はメンバーが参照されていることを示し、E：を使用してイベントを指していることに注意してください。T：タイプに使用されますが、存在しない場合はそれが想定されます。

于 2008-12-26T12:08:47.710 に答える
1

グループ化はサンドキャッスルが自動で行ってくれますが、オーバーロードのグループに共通の説明を付けたい場合は、これに <overloads> タグを使います (<summary> と同じ方法)。これは標準の XML ドキュメント タグではありませんが、AFAIR は Sandcastle Help File Builder でサポートされています。

于 2010-02-09T16:34:54.590 に答える