Doxygen pour créer de la documentation pour les code C# avec des commentaires XML
J'ai lu partout que doxygen est la voie à suivre pour la génération de documentation de code C#. J'ai une seule et même interface que j'ai envie de document (étapes de bébé), et il a déjà les commentaires XML ( ///).
En raison du grand nombre de postes et les informations disponibles (y compris les doxygen.org qui disent ces commentaires sont déjà pris en charge, je suis surpris de voir que quand je lance doxywizard, j'ai des erreurs comme "avertissement: Mélange Société::Produits::MyInterface n'est pas documentée".
Cela me mène à croire que j'ai quelque peu mal compris de la documentation XML (j'espère ne pas, selon MSDN je parle de la chose), ou j'ai mal configuré doxywizard.
J'ai couru doxywizard l'aide de l'Assistant de l'onglet, et précisé que je veux à l'appui de C#/Java. Quand je le lance, mon code HTML de la page est vide, probablement en raison de l'mentionnées précédemment mises en garde. J'ai ensuite essayé de spécifier un fichier unique via l'onglet Expert et a couru de nouveau -- même comportement.
Quelqu'un peut me dire ce commutateur ou de réglage, je suis absent pour obtenir doxygen pour générer du HTML?
Voici un exemple de ce qu'un documentés de propriété/méthode ressemble dans mon interface:
///<summary>
///Retrieve the version of the device
///</summary>
String Version { get; }
///<summary>
///Does something cool or really cool
///</summary>
///<param name="thing">0 = something cool, 1 = something really cool</param>
void DoSomething( Int32 thing);J'ai un commentaire au-dessus de l'interface, comme ceci:
///<summary>
///MyInterface
///</summary>
public interface MyInterface {...}oui je le fais... j'ai mis à jour ma question pour afficher le commentaire. Peut-être que j'ai besoin de quelques spéciales doxygen syntaxe?
Hmmm.... Que tout se passe bien. Tout ce que je peux penser, c'est que il y a un tas de EXTRACT_ paramètres. Essayez de mettre tous OUI. Ce que vous essayez de le faire fonctionner. Il y a juste quelque chose qui manque. Il y a un peu plus d'essai-et-erreur requis avec doygen que je le voudrais.
haha, bon timing! J' publié à ce sujet après avoir lu quelque chose à propos de EXTRACT_ALL. Permettant de le faire fonctionner, mais je sens qu'il doit avoir travaillé, même avec ce paramètre. Merci pour les commentaires.
OriginalL'auteur Dave | 2011-08-31
Vous devez vous connecter pour publier un commentaire.
Je crois que j'ai compris. Le doxygen manuel dit que EXTRACT_ALL = 0 est le paramètre par défaut, et dans ce cas "ne fera que générer de la documentation pour documenté membres, des fichiers, des classes et espaces de noms". Maintenant, je pensée que j'avais documenté correctement, mais apparemment pas. J'ai juste activé EXTRACT_ALL, et les mises en garde s'en alla, et j'ai eu de la documentation pour mon interface! J'ai lu sur les blocs de documentation", en pensant qu'il me manquait quelque chose (merci à Eric Farr du commentaire), mais il ne fait aucune mention de faire quelque chose de spécial pour le code C#, je suis donc sous l'hypothèse que la valeur par défaut pour EXTRACT_ALL devrait avoir encore travaillé.
OriginalL'auteur Dave