Comment afficher les commentaires généraux sur la fonction Surcharges

Question

J'ai créé une fonction avec des surcharges. Maintenant, je veux ajouter des commentaires pour chaque surcharge, mais ne pas répéter le contenu récapitulatif encore et encore. Je veux seulement que la description du paramètre soit donnée.

à savoir

/// <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 
    } 

Ici, je ne veux pas écrire la section de synthèse encore et encore, mais veulent écrire des commentaires sur la partie des paramètres uniquement. Le repos devrait être visible pour chaque surcharge.

Est-il possible de le faire?

Answer 1

Vous pouvez utiliser include tag pour y parvenir.

Créez un fichier xml avec un résumé commun, les descriptions des paramètres de vos méthodes surchargées.

Et référence dans votre chaque méthode surchargée, et ajouter des commentaires spécifiques méthode de la liste param seul dans votre méthode surchargée.

/// <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 
} 

Et ur fichier xml est quelque chose comme

<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> 

je n'ai pas testé ... vous pouvez essayer