Qual è il modo migliore per aggiungere tag di riepilogo a una classe proxy del servizio Web generata?

Question

Aloha

Sto facendo riferimento a un servizio Web esterno nella mia applicazione .NET 2.0. L'aggiunta di un riferimento al servizio ha generato per me una bella classe proxy. Vorrei aggiungere ///<summary> documentazione di stile a questo. Se il riferimento al servizio viene aggiornato, tutti i miei brillanti commenti spariranno.

C'è qualche soluzione a questo?

Answer 1

È possibile creare una classe wrapper attorno alla classe proxy generata e documentare i metodi lì. Quindi invece di utilizzare direttamente il proxy generato, usi sempre la tua classe wrapper. Per esempio:

public class MyWebServiceWrapper
{
  private MyWebService _service = null;

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

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

Questo approccio consente di rigenerare la classe proxy ogni volta che è necessario.

Ovviamente questo significa che dovrai (manualmente) aggiornare la classe wrapper ogni volta che cambia l'interfaccia del servizio web. D'altra parte, la classe wrapper consente anche di aggiungere una gestione centralizzata degli errori, ecc.