クラス ドキュメントをソース コードから自動的に生成できるように、C# コードにコメントを付けるための標準的な規則 (phpdoc や python の docstring など) はありますか?
Mark Biek
質問する
19770 次
6 に答える
38
XML スタイルのコメントを使用し、ツールを使用してそれらのコメントを API ドキュメントに引き出すことができます。
コメント スタイルの例を次に示します。
/// <summary>
/// Authenticates a user based on a username and password.
/// </summary>
/// <param name="username">The username.</param>
/// <param name="password">The password.</param>
/// <returns>
/// True, if authentication is successful, otherwise False.
/// </returns>
/// <remarks>
/// For use with local systems
/// </remarks>
public override bool Authenticate(string username, string password)
これを容易にするためのいくつかの項目は次のとおりです。
GhostDocは、クラスまたはメソッドのコメントを自動的に生成するための単一のショートカット キーを提供します。 XML コメントから MSDN スタイルのドキュメントを生成するSandcastle 。
于 2008-08-29T16:02:39.923 に答える
3
/// <summary>
///
/// </summary>
/// <param name="strFilePath"></param>
于 2008-08-29T16:01:37.493 に答える
1
Microsoft は " XML ドキュメント コメント" を使用しています。これにより、IDE インテリセンスの説明が提供されます。また、XML ファイル出力の生成をオンにすると、Sandcastle などのツールを使用して MSDN スタイルのドキュメントを自動生成することもできます。
ドキュメント用の XML ファイルの生成を有効にするには、Visual Studio でプロジェクトを右クリックし、[プロパティ] をクリックして [ビルド] タブに移動します。下部に向かって、XML コメント出力ファイルの場所を指定できます。
于 2008-08-29T16:04:10.730 に答える
1
前の回答は、XML 構文を完全に指摘しています。プロジェクト内のすべてのコメントを解析する無料 (およびオープンソース) の nDoc ヘルプ ライブラリ ジェネレーターについて、私の推奨事項を紹介したいと思います。
于 2008-08-29T16:40:29.443 に答える
1
C# にはドキュメント コマンドが組み込まれています 。
于 2008-08-29T16:01:58.910 に答える
0
私は常に、2 つ以上のアスタリスクで開かれたブロック コメントを使用して、ドキュメント コメントを区切るように言われました。
/**
Documentation goes here.
(flowerboxes optional)
*/
于 2009-03-31T01:00:38.337 に答える