読者です 読者をやめる 読者になる 読者になる

プログラマーな日々

プログラマーをやっています。好きなツール:WorkFlowy、好きな言語:C#、好きなサービス:Backlog、好きなAWS:AWS Lambda。

名前空間のドキュメントコメントをSandcastleで出力する

Sandcastleは名前空間のコメントに対応しています。
Using NamespaceDoc Classes
Namespace comments can also be specified and maintained in your source code by adding an empty NamespaceDoc class to each namespace. When comments for this class are found in the XML comments files they will be used as the namespace comments. Note that you can use the class and also specify namespace comments in the help file builder project. When this occurs, the project namespace summary comments will be appended to the comments from the NamespaceDoc class comments. ...

Summary以外にも以下の推奨するタグが使えるようです。
ドキュメント コメント用の推奨タグ (C#)
C# コンパイラは、コード中のドキュメント コメントを処理して XML ファイルを生成します。ドキュメントを作成するために XML ファイルを処理する詳細は、サイトに実装する必要があります。 タグは、型や型メンバなどのコードの構成体に対して処理されます。 ...

名前空間のコメント

以下のようにXMLコメントを書くと、

namespace Foo.Bar {
    /// <summary>
    /// サマリーの文章。
    /// </summary>
    /// <remarks>
    /// <para>
    /// <strong>タイトル</strong>
    /// </para>
    /// <para>
    /// 段落の文章
    /// </para>
    /// <para>
    /// <see cref=" Foo.Bar.HogeClass"/> クラスへの参照。
    /// <list type="number">
    /// <item><description>項目1。</description></item>
    /// <item><description>項目2。</description></item>
    /// <item><description>項目3。</description></item>
    /// </list>
    /// </para>
    /// </remarks>
    [System.Runtime.CompilerServices.CompilerGeneratedAttribute]
    class NamespaceDoc {
    }
}

HTMLヘルプ

Sandcastleではこのように出力されます。