J'ai récemment commencé sur un projet pour développer une API reposante dans la WCF, et je vais avoir besoin d'exposer la documentation avec l'API elle-même. J'espérais tirer parti des commentaires du code XML dans mes documents pour cette documentation.
Mais ce que je veux produire, ce sont les contrats exposés par le service: les points d'extrémité et les structures d'objet JSON / XML. Depuis que j'essaie de créer une documentation externe, je m'intéresse à l'un des internes de ma bibliothèque ou de la manière dont il est lié à la framework .NET (ou même que c'est .net, d'ailleurs).
Quelles sont mes options pour les outils, pour créer ces documents? J'ai entendu dire que Sandcastle ou Doxygen sont de bons outils pour générer des documents des commentaires de code XML, mais puis-je filtrer les classes et les méthodes que je ne veux pas exposer?
3 Réponses :
Vous pouvez configurer Doxygen pour générer du document à partir de fichiers speficied. Pourquoi ne pas regarder les documents de Doxygen?
Bien sûr, vous pouvez filtrer des apimembers indésirables avec Sandcastle. Ce blogentry décrit comment . Si vous êtes nouveau à Sandcastle, vous voudrez peut-être essayer Builder Aide Sandcastle aussi, ce qui est fondamentalement un Sandcastle frontend.
+1 - shfb est une bouée de sauvetage et réduit le temps pour configurer votre sortie au point qu'il est indolore. J'ai également travaillé avec l'intégration de mon processus de construction de l'équipe, nous avons donc toujours une documentation à jour.
Je comprends que cette question a été posée Pre -.net 4.0, mais à partir de .NET 4.0, vous pouvez créer une «page d'aide» comme décrit dans page d'aide du service HTTP HTTP WCF .
[System.ComponentModel.Description("Triggers Method Name Behavior.")]
public void MethodName() {}
+1 C'est exactement ce que je cherchais pour .net 4! Kudos @rickglos
Ce n'est pas du repos, veuillez supprimer la balise [reposante]. Si vos URI de point final sont dans votre API, ce n'est que RPC.
@aehlke Quelle partie de ce qui précède vous suggère que ce n'est pas la mise en œuvre du repos de WCF?
Peut-être signifie-t-il que la tendance selon laquelle les bonnes API de repos représentent le graphique de l'objet dans la mise en page et la structure de leurs documents, comme développeurs.soundcloud.com/docs/api