共用方式為

<param> (C# 程式設計手冊)

  • 發行項
<param name="name">description</param>

參數

  • name
    為方法參數的名稱。 以雙引號 (" ") 將名稱括起來。

  • description
    參數的描述。

備註

<param> 標記應使用於方法宣告的註解中，以描述該方法其中之一的參數。 若要提供多個參數，請使用多個 <param> 標記。

<param> 標記的文字將會顯示在 IntelliSense、物件瀏覽器和程式碼結構 Web 報告中。

使用 /doc 進行編譯，將文件註解處理為檔案。

範例

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    // Single parameter.
    /// <param name="Int1">Used to indicate status.</param>
    public static void DoWork(int Int1)
    {
    }

    // Multiple parameters.
    /// <param name="Int1">Used to indicate status.</param>
    /// <param name="Float1">Used to specify context.</param>
    public static void DoWork(int Int1, float Float1)
    {
    }

    /// text for Main
    static void Main()
    {
    }
}

請參閱

參考

建議使用的文件註解標籤 (C# 程式設計手冊)

概念

C# 程式設計手冊