c# - .NET でメンバーを文書化するためにインライン コメントを使用する方法は?

Question

.Net でメンバーをインラインで文書化するにはどうすればよいですか? 説明させてください。コメントからドキュメントを抽出するほとんどのツールは、メンバー宣言の後に簡単な説明を追加できるインライン ドキュメントをサポートしています。何かのようなもの：

public static string MyField; /// <summary>Information about MyField.</summary>

C# または .NET 言語でこれを行う方法はありますか?

Answer 1

いいえ、できません。XML コメントは、ブロック レベルのコメントとしてのみサポートされます。つまり、ドキュメント化するコード要素の前に配置する必要があります。.NET コードから XML コメントを抽出するための一般的なツールは、そのようなインライン コメントを解析する方法を理解していません。この機能が必要な場合は、独自のパーサーを作成する必要があります。

Answer 2

これを行う組み込みの方法はありません。XML ドキュメント システムは階層的です。<summary />タグとその直後のデータとの関係を定義します。

Answer 3

はい、コメントしたいものの前に置いてください

/// <summary>Information about MyField.</summary>
public static string MyField;