.net - .NET DLL で定義された関数の情報を追加する方法

Question

.NET 関数に付属する C# のメソッドの XML ドキュメントを追加するにはどうすればよいですか。

例

Guid.NewGuid();

ユーザーが を押したとき。key 彼は、関数 NewGuid が何をするかについてのヘルプを取得します。

getDocTag のような関数を持つクラス GetDocsInfo があり、同様の機能が必要です。属性のように追加する必要があるメタデータの種類はありますか

Answer 1

あなたが話しているのは、単に示されているインテリセンスです。これは、関数またはプロパティのコメント メタデータから抽出されます。

/// <summary>
/// My details here....
/// </summary>
public void MyFunction()
{
    ... etc ...
}

文書化する関数の上の行に編集カーソルを置き、スラッシュを 3 つ続けて入力すると、Visual Studio によってコメント セクションが自動入力されます。詳細を挿入するだけです。

または、 GhostDocという Visual Studio プラグインを使用することもできます。これにより、コンテキスト メニューにオプションが表示され、関数を自動的にドキュメント化できます。パラメータと関数の名前に基づいてドキュメントの内容を適切に決定します。

Answer 2

関数またはクラスの上に「///」を書くことによって

https://stackoverflow.com/questions/641364/c-documentation-generator

Answer 3

クラス メンバーの XML ドキュメントを追加する必要があります。Visual Studio でコードを入力しているときに、メンバー定義の行で / キーを 3 回押すと、編集可能なスケルトンが生成されます。

/// <summary>
/// What your function does.
/// </summary>
/// <param name="paramterName">Description of parameter</param>
public void Method Name(string paramterName)
{
}

Answer 4

C# で行うのは非常に一般的なことなので、正しく理解しているかどうかはわかりませんが、C# を使用している場合は、トリプル スラッシュを使用して関数のドキュメントを生成できます。

/// <summary>
/// Adds two numbers
/// </summary>
/// <param name="x">First number</param>
/// <param name="y">Second number</param>
/// <returns>The sum of specified numbers</returns>
private int Sum(int x, int y)
{
    return x + y;
}