Asp.net - comment mettre des commentaires visibles sur un webservice

Soyez le premier à donner votre avis sur cette source.

Snippet vu 10 985 fois - Téléchargée 35 fois

Contenu du snippet

Toujours dans la même idée de la documentation et la clareté de son code source, il peut être très utile d'ajouter un commentaire sur un WebService (disant à quoi il sert par exemple), et sur chaque fonctions de celui-ci.

Ainsi on pourra avoir un WebService avec le but de l'ensemble de ce WebService, et une spécification de chaque fonction pouvant par exemple spécifier les paramêtres d'entrée et de sortie.

Source / Exemple :


' Dans le code source xxxx.asmx.vb

Namespace Services
  <WebService(Namespace:="http://tempuri.org/", Description:="Le Commentaire général de mon WebService Qui s'affichera dans le haut de la page ASMX")> _
  Public Class MonWebService
     Inherits System.Web.Services.WebService

       <WebMethod(Description:="Le Commentaire sur la fonction du WebService")> _
       Public Function MaFunction(ByVal MaVariable As String) As String
       .....
       End Function

    ....

  End Class
End Namespace

Conclusion :


Bon Coding.

Romelard Fabrice (Alias F___)

A voir également

Vous n'êtes pas encore membre ?

inscrivez-vous, c'est gratuit et ça prend moins d'une minute !

Les membres obtiennent plus de réponses que les utilisateurs anonymes.

Le fait d'être membre vous permet d'avoir un suivi détaillé de vos demandes et codes sources.

Le fait d'être membre vous permet d'avoir des options supplémentaires.