如何顯示功能過載的一般註釋

Question

我已經創建了一些重載函數。 現在我想爲每個重載添加註釋，但不會一次又一次地重複摘要內容。我只想給出參數描述。

即

/// <summary> 
    /// Binds Control With DataTable/DataSet Passed as a Parameter. DataTable/Control Should not be NULL. 
    /// </summary> 
    /// <param name="lbx">DropDownList control</param> 
    /// <param name="dt">Object of DataTable from where value need be fetched.</param> 
    /// <param name="displayMember">Display Member for the list</param> 
    public static void Source(this DropDownList ddl, DataTable dt, string displayMember) 
    { 
    // do something. 
    } 

    /// <summary> 
    /// Binds Control With DataTable/DataSet Passed as a Parameter. DataTable/Control 
    /// </summary> 
    /// <param name="lbx">DropDownList control</param> 
    /// <param name="dt">Object of DataTable from where value need be fetched.</param> 
    /// <param name="displayMember">Display Member for the list</param> 
    /// <param name="_setDefaultItem">If True Sets the default value as -1 and corresponding string</param> 
    public static void Source(this DropDownList ddl, DataTable dt, string displayMember, bool _setDefaultItem) 
    { 
    //do something 
    } 

在這裏，我不想一次又一次地寫總結部分，但想寫唯一參數部分意見。每次過載都應該可見。

有什麼辦法嗎？

Answer 1

您可以使用include標籤來實現此目的。

創建一個xml文件，其中包含常用的摘要，重載方法的參數描述。

並在您的每個重載方法中引用此方法，並在您的重載方法中單獨添加方法特定的參數列表註釋。

/// <include file='common_tag.doc' path='MyDocs/MyMembers[@name="source"]/*' /> 
public static void Source(this DropDownList ddl, DataTable dt, string displayMember) 
{ 
// do something. 
} 

/// <include file='common_tag.doc' path='MyDocs/MyMembers[@name="source"]/*' /> 
/// <param name="_setDefaultItem">If True Sets the default value as -1 and corresponding string</param> 
public static void Source(this DropDownList ddl, DataTable dt, string displayMember, bool _setDefaultItem) 
{ 
//do something 
} 

和UR XML文件是一樣的東西

<MyDocs> 

<MyMembers name="source"> 
<summary> 
Binds Control With DataTable/DataSet Passed as a Parameter. DataTable/Control Should not be NULL 
</summary> 
<param>....</param> 
</MyMembers> 


</MyDocs> 

我沒有測試過這...你可以試試這個