Quel est le meilleur moyen d'ajouter des balises de résumé à une classe de proxy webservice générée?

Question

Aloha

Je référence un service web externe dans mon application .NET 2.0. L'ajout d'une référence de service a généré une classe de proxy sympa pour moi. Je voudrais ajouter la documentation de style ///<summary> à cela. Si la référence du service est mise à jour, tous mes commentaires brillants ont disparu.

Y at-il une solution à cela?

Answer 1

Vous pouvez créer une classe wrapper autour de la classe proxy générée et documenter les méthodes à cet endroit. Ensuite, au lieu d'utiliser le proxy généré directement, vous utilisez toujours votre classe wrapper. E.g:

public class MyWebServiceWrapper 
{ 
    private MyWebService _service = null; 

    public MyWebServiceWrapper() 
    { 
    _service = new MyWebService(); 
    } 

    ///<summary> 
    /// doc goes here 
    ///<summary> 
    public int MethodOne() 
    { 
    return _service.MethodOne(); 
    } 
} 

Cette approche vous permet de générer de nouveau la classe proxy chaque fois que nécessaire.

Bien sûr, cela signifie que vous devrez mettre à jour (manuellement) la classe wrapper chaque fois que l'interface du service web change. D'autre part, la classe wrapper vous permet également d'ajouter une gestion centralisée des erreurs, etc.