c# - C# クラスライブラリからドキュメントを生成する

Question

多数のプロジェクトを含む C# クラスライブラリを開発しました。これを複数の異なるプロジェクトで共通のライブラリとして使用しています。

最近、多くの異なる開発者がチームに参加しましたが、ライブラリに慣れていないため、何が含まれているのかわかりません。私は、ghostdoc の助けを借りて十分にコメントしました。

ライブラリのツールを使用してドキュメントを自動生成することは可能ですか? 開発者に読んでもらうことができるドキュメントを生成するツールを実行したいと思います。そのようなツールは、コメントからドキュメントを生成すると思います。

score 4 · Accepted Answer

ソースコードからドキュメントを生成するには、 Sandcasle Help File Builderを使用することをお勧めします。生成されたドキュメントの品質と堅牢性は、使用する XML コメントの豊富さに直接関係するため、XML ドキュメントコメントを確認する必要があります。

SHFB は、HTML および/またはコンパイル済みのヘルプドキュメントを生成できます。

score 2 · Accepted Answer

Visual Studio を使用している場合は、プロジェクトのプロパティに移動し、[ビルド] を選択してから、[出力] の下で [XML ドキュメントファイル] チェックボックスをオンにします。

score 1 · Accepted Answer

私は最近、C# コードからマークダウンドキュメントを生成する使いやすいライブラリを作成しました。必要なのは、クラスライブラリの dll ファイルだけです。
試してみたい場合は、生成されたドキュメントの例とともに使用を開始する方法に関するリンクを次に示します。

c# - C# クラス ライブラリからドキュメントを生成する