0

私はメソッドなどを文書化するためにGhostDocを使用しています...そしてうまく機能していますが、それは<returns>...

誰か私が何をすべきか教えてもらえますか

「ロール」というオブジェクトが返された場合

<returns>A role object see <see cref = "UserRole" /></returns>

または単に

<returns>A role object</returns>

また

<returns>A role</returns>

私はその音が少し正確すぎることを知っていますが、私は正しいことから始めたいです:-)

たとえば、ユーザー名の標準の文字列戻り値の型を考えてみましょう

<returns>The user name</returns>

<returns>The user name, see <see cref = "system.string" /> </returns>
4

1 に答える 1

3

MSDN から手がかりを得る (例 1、例 2 ):

<returns>A <see cref="string" /> that contains the username</returns>

<returns>An object that contains role information</returns>

ドキュメント ジェネレーターには戻り値の型が含まれるため、常に含める必要はありません。ただし、それが理にかなっている (または指摘したい) 場合は、そうすることは問題ではありませんが、おそらく、別の "see X" ステートメントとしてではなく、フロー内のステートメントです。

于 2011-01-26T17:52:52.680 に答える