c# - null 許容型のドキュメント生成

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}TBooleanXYZ

これを読み取るツールを変更するか (どのように行うかはわかりません)、参照を別の方法で書き出す必要があります。

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

Answer 2

使ってみてはどうですか

Nullable<bool>