c# - 可空类型的文档生成

Question

关于 C# 编译器生成文档的问题。

源代码:

public class SomeClass {
    /// <summary>
    /// Do some work
    /// </summary>
    /// <returns cref="Nullable{Boolean}">
    /// Some stuff
    /// </returns>
    public bool? SomeMethod() {
       return false;
    }
}

编译器为方法 SomeMethod 生成了 XML 文档片段:

<member name="...." >
 ....
  <returns cref="T:System.Nullable`1">SomeStuff</returns>
</member>

有什么办法可以强制产生

<member name="...." >
 ....
  <returns cref="T:System.Nullable{System.Boolean}">SomeStuff</returns>
</member>

代替.?

Answer 1

很遗憾没有。

无法更改 .xml 文件的生成方式。

相反，您将不得不更改正在处理这些文件的任何内容以处理该语法，或者更改 XML 文档。

这里的问题是 Nullable{Boolean} 和 Nullable{T} 没有区别，因为括号之间的部分不理解为类型，而是理解为泛型类型参数。 T、Boolean、XYZ，都是一样的。

您要么必须更改读取它的工具(我不知道您将如何做)，要么以不同的方式写出您的引用:

/// <returns>
/// <see cref="Nullable{T}/> with <c>T</c> being <see cref="Boolean"/>.
/// </returns>