c# - DLLのパラメータにコメントを追加する

Question

.NETでDLLを作成しましたが、これにはいくつかの機能が含まれています。現在、このDLLを別のアプリで訴えています。

クライアントが私のDLLを使用するときはいつでも、このようなリターンタイプ、パラメータなどを示す何らかのコメントを表示する必要があります。

XMLファイルを使用している人を見かけますが、別の方法はありますか？柔和に感謝

Answer 1

メンバー宣言の前に、コメントで指定されたXML ドキュメントを使用する必要があります。

/// <summary>Some stuff here</summary>
/// <remarks>Some remarks</remarks>
/// <param name="foo">The foo to gronk</param>

次に、プロジェクトのプロパティに移動し、[ビルド] タブでライブラリと共に XML ファイルのビルドを有効にします。これを DLL と一緒に配布すると、Visual Studio にコンテンツが表示されます。

Answer 2

/// <summary>
/// This method does something.
/// </summary>
/// <param name="zain">Zain to be processed.</param>
/// <returns>True if it went okay, false otherwise.</returns>

Answer 3

メソッド宣言の先頭で///を使用します。

/// <summary>
/// This method does something.
/// </summary>
/// <param name="foo">Foo value to be processed.</param>
/// <returns>True if it went okay, false otherwise.</returns>
public bool DoSomething(int foo)
{
    if (foo > 0)
        return true;
    else
        return false;
}

Answer 4

前述のとおり、各パブリック メンバーの先頭に XML ドキュメントを追加できます。

/// <summary>
/// This is the summary for your method.
/// </summary>
public void MyMethod()
{
    /// your code here...
}

プロセスを支援するツールが多数あります。コメントを生成するためのGhostDocと、そこからヘルプ ファイルまたは Web ページを作成するためのSandcastleを調べてください。