.net - XML 文档：在，这是可以接受的还是没有必要的？

Question

我正在使用 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>

Answer 1

从 MSDN（示例 1、示例 2）中获取提示：

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

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

文档生成器将包含返回值的类型，因此不必总是包含它；但是，如果它有意义（或者您想指出它），这样做不是问题，但可能在流程中声明，而不是作为单独的“see X”声明。