XML文档：在<returns>中使用“cref”，这是可接受的还是不必要的？</returns>

Question

我正在使用GhostDoc记录我的方法等...并且它运行良好但它没有填充<returns> ......

任何人都可以告诉我应该做什么，即

如果它返回一个名为“Roles”的对象，那么

<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（example 1，example 2）中获取提示：

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

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

文档生成器将包含返回值的类型，因此不必总是包含它;但是，如果它有意义（或者你想指出它），这不是一个问题，但可能在流程中，而不是单独的“看到X”语句。