Auto-documentant asp.net api

J'ai créé une API Asp.net dans VS2015. A l'intérieur des zones> Helppage> App_Start> HelpPageConfig.cs I décommenté ligne 37Auto-documentant asp.net api

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

Il n'y avait pas XmlDocument.xml dans le dossier App_Data pour le projet, donc je créé un avec les étiquettes que je l'avais vu dans la documentation auto années xml Dans les autres API,

<?xml version="1.0" encoding="utf-8" ?> 
<doc> 
    <assembly> 
    <name>NameOfApiHere</name> 
    </assembly> 
    <members> 
    </members> 
</doc>

mais lors de la création et/ou de l'exécution de l'application, rien ne va dans le XML. Je comprends que lorsque cela est activé les documents XML sel basés sur chaque résumé /// pour une méthode donnée avec une alerte intellisense pour toute méthode publique qui n'a pas de résumé, mais je ne trouve aucun code qui copierait explicitement informations récapitulatives à ce xml en tant que "membre" des balises à l'intérieur de la balise "membres" et ce n'est pas le cas. Quelle étape manque-t-il que je ne vois pas dans le comment sur Internet pour activer la documentation personnelle dans un APi?

Source

2017-07-31 davidp04

Dans les propriétés du projet, remplissez le dossier de destination de la documentation XML dans le dossier de votre choix. Je suppose qu'il serait préférable d'utiliser app_data au lieu de App_code dossier.

un coup d'oeil en 1ère et 2e étapes de this question answer

Source

2017-07-31 19:56:02 ASpirin

Cela m'a conduit à elle, il était dans les propriétés unter build, je devais à la fois vérifier "XML Documentation file:" et définir le chemin de mon xml – davidp04

avez-vous essayé de modifier le dossier de 'app_data'? En tout cas 'XmlDocumentationProvider' est dans votre projet Déboguez-le et vous verrez pourquoi il ne fonctionne pas – ASpirin

oui, il est dans App_data, le App_Code était une faute de frappe dans la question que je vais corriger – davidp04

Essayez de supprimer le fichier XmlDocument.xml que vous avez ajouté (je pense que ce génère automatiquement) et indiquer le chemin d'accès dans les paramètres du projet -> Construire onglet dans la sortie section.

Source

2017-07-31 19:57:28

Auto-documentant asp.net api

Répondre

Questions connexes