Où mettez-vous la documentation de la fonction pour qu'elle apparaisse sur intellisense?

Question

J'écris une librairie et je veux mettre de la documentation dans mes fonctions pour qu'elle apparaisse dans intellisense, un peu comme l'intellisense pour les fonctions intégrées montre des descriptions pour chacun des paramètres et pour la fonction elle-même. Comment mettez-vous la documentation? Est-ce à travers des commentaires dans la fonction ou est-ce dans un fichier séparé?

Answer 1

Utilisez les commentaires XML au-dessus de la signature de la fonction.

/// <summary> 
    /// Summary 
    /// </summary> 
    /// <param name="param1">Some Parameter.</param> 
    /// <returns>What this method returns.</returns> 

Le plugin GhostDoc peut vous aider à les générer.

Answer 2

Outre les commentaires XML, vous devez activer la création de la documentation (dans les paramètres du projet) et conserver le fichier XML généré avec l'assemblage.

Answer 3

« XML Les commentaires de documentation (C# Guide de programmation) Dans Visual C#, vous pouvez créer de la documentation pour votre code en incluant des balises XML dans les champs de commentaires spéciaux dans le code source directement avant le bloc de code qu'ils font référence. »

http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

vous pouvez ensuite utiliser Sandcastle pour générer des fichiers CHM aussi si vous voulez

http://www.hanselman.com/blog/SandcastleMicrosoftCTPOfAHelpCHMFileGeneratorOnTheTailsOfTheDeathOfNDoc.aspx

Answer 4

Pour générer automatiquement la section des commentaires de trois slash sur le dessus d'une méthode existante, placez simplement le curseur sur une ligne vide, juste au-dessus de la définition de la méthode et tapez trois barres obliques ("///"). Visual Studio générera automatiquement un commentaire à trois barres qui correspond à votre méthode. Il aura des espaces réservés pour le résumé, chaque paramètre (le cas échéant) et la valeur de retour (le cas échéant). Vous avez juste à remplir les espaces vides.

Je vous recommande de ne pas essayer d'écrire ces blocs de description à la main et de ne pas copier d'une méthode à l'autre. Les outils tiers ne sont pas non plus nécessaires pour les générer (au moins dans Visual Studio 2010).