XMLコメントでタイプを指定する方法コメント

Question

C＃XMLコメントの<return>コメントで、出力（Sandcastleを使用）で返されるタイプを指定したいのですが、その方法がわかりません。

疑似例： ジェネラコディセタグプレ

上記の例は、ドキュメントのSyntaxセクションに記載されている戻り値の型を指定する方法をSandcastleに指示するという私の推測のモックです。そうではありません。

わかりやすくするために、 GetHastCode（）メソッドは、私が狙っている戻り値の型を示しています。

タイプを手動で指定する必要がありますか、それともタイプを指定して（モックの例と同様）、Sandcastleに出力の表示/フォーマット方法を決定させることができますか？Sandcastleがパラメータのタイプを自動的に表示/フォーマットする方法と同様です。 <param>タグ。

Answer 1

この投稿（2011年7月）は、<return>タグ内に表示される戻り値の型の欠如に関してEric Woodruff（SHFB作成者）からの応答があります：

Sandcastleはリターンのタイプ情報をレンダリングしません 情報と私はそれが今まで持っていないと思います。提供される情報は リフレクション情報ファイルでは、XSL変換は次のようになります。 それをレンダリングするように変更されました。今は調べる時間がありませんが、 ある時点で、それが可能かどうかを確認することができます。

私のOPに対する公式の答えは次のとおりだと思います。Sandcastleには戻り値の型を自動的に指定する方法はありませんが、Skeetがすでに言及したように、XSL変換を変更することでこれを実現できる可能性があります。 p>

Answer 2

XMLドキュメントで指定する必要はありません。結局のところ、メソッド宣言にあることを考えると、冗長になります。

本当に必要な場合は、サンドキャッスルスタイルを微調整する必要があると思いますが、特に便利だと思いますか？ユーザーがメソッドシグネチャの戻り値の型をクリックできないわけではありません。（少なくとも、SHFBのプロトタイプスタイルの場合はそう思われます。 Noda Timeのドキュメントの例をご覧ください。）

MSDNでは、メソッドシグネチャにリンクがありません （少なくともChromeではありません。IEで異なるかどうかはわかりません）が、個人的にはシグネチャに含めることをお勧めします実際のドキュメントを乱雑にする代わりに。