2009-03-16 9 views
4

Lorsque vous démarrez un projet WebService dans VisualStudio (VS), vous voyez effectivement de la documentation HTML, mais l'aide au commentaire C# ne passe pas au format HTML. Vous pouvez obtenir une description pour chaque méthode Web en utilisant la propriété Description de l'attribut WebMethod, mais cela signifie dupliquer le texte de l'aide de commentaire et ne permet pas non plus de documenter les arguments de méthode Web autant que je peux le dire.Comment puis-je générer de la documentation HTML pour une classe SOAP/WebService dans .Net?

Existe-t-il un moyen facile de récupérer l'aide aux commentaires déjà présente dans le code C#?

Merci.

+0

C'est une bonne question! –

+3

Voilà pourquoi il y a des boutons de vote! – redcalx

Répondre

1

Nous utilisons maintenant la bibliothèque WCFExtra pour convertir les commentaires XML dans mon code en commentaires de documentation dans le WSDL. De là, nous utilisons TechWriter pour construire la documentation.

+1

Ne pas écrire des commentaires en tant que réponses s'il vous plaît. – SiN

1

Les commentaires C# ne sont pas compilés dans l'assembly. Il existe un solution over at Codeproject pour fournir une documentation WSDL alternative: il ne devrait pas être trop difficile de configurer une application ASP.NET pour lire le fichier de documentation XML brut, avec une certaine configuration pour faire correspondre les services et les opérations WSDL aux classes et aux méthodes.

Je ne sais pas s'il existe des solutions prêtes à l'emploi pour votre problème.