Comment avoir des commentaires dans IntelliSense pour la fonction dans Visual Studio?

ce dont vous avez besoin est commentaires xml - fondamentalement, ils suivent cette syntaxe (comme vaguement décrit par Solmead):

c#

///<summary>
///This is a description of my function.
///</summary>
string myFunction() {
     return "blah";
}

VB

'''<summary>
'''This is a description of my function.
'''</summary>
Function myFunction() As String
    Return "blah"
End Function

<c>text</c> - le texte que vous souhaitez indiquer comme code.

La balise < c > vous permet d'indiquer que le texte d'une description doit être marqué comme code. Utilisez < code > pour indiquer plusieurs lignes comme code.

<code>content</code> - le texte que vous voulez marqué comme code.

La balise < code > vous permet d'indiquer plusieurs lignes en tant que code. Utilisez < c > pour indiquer que le texte dans une description doit être marqué comme code.

<example>description</example> - une description de l'échantillon de code.

L' < exemple > balise permet d'indiquer un exemple d'utilisation d'une méthode ou d'un autre membre de la bibliothèque. Cela implique généralement l'utilisation de la balise < code >.

<exception cref="member">description</exception> - une description de l'exception.

La balise < exception > vous permet de spécifier quelles exceptions peuvent être lancées. Cette balise peut être appliquée aux définitions de méthodes, propriétés, événements et indexeurs.

<include file='filename' path='tagpath[@name="id"]' />

La balise < include > vous permet de vous référer à des commentaires dans un autre fichier qui décrivent les types et les membres de votre code source. Il s'agit d'une solution de rechange à la présentation directe des commentaires de la documentation dans votre fichier de code source. En plaçant la documentation dans un fichier séparé, vous pouvez appliquer le contrôle source à la documentation séparément du code source. Une personne peut faire vérifier le fichier de code source et une autre peut faire vérifier le fichier de documentation. La balise < include > utilise la syntaxe XML XPath. Reportez-vous à la documentation de XPath pour des façons de personnaliser votre < include > utilisation.

<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>

le bloc < listheader > sert à définir la rangée de titres d'un tableau ou d'une liste de définitions. Lorsque vous définissez un tableau, vous n'avez qu'à fournir une entrée pour terme dans le titre. Chaque élément de la liste est spécifié par un bloc < article >. Lors de la création d'une liste de définition, vous devrez spécifier à la fois le terme et la description. Cependant, pour un tableau, une liste à puces ou numérotée liste, vous avez seulement besoin de fournir une entrée pour description. Une liste ou une table peut avoir autant de blocs < item > que nécessaire.

<para>content</para>

L' < para > balise est pour une utilisation à l'intérieur d'une balise < résumé >, < remarques >, ou < renvoie >, et vous permet d'ajouter de la structure du texte.

<param name="name">description</param>

Le< param > l'étiquette doit être utilisée dans le commentaire d'une déclaration de méthode pour décrire l'un des paramètres de la méthode. Pour documenter plusieurs paramètres, utilisez plusieurs balises < param >.

Le texte de la balise < param > sera affiché dans IntelliSense, le navigateur D'objets, et dans le rapport de commentaire de Code web.

<paramref name="name"/>

Le < paramref > balise permet d'indiquer qu'un mot dans les commentaires de code, par exemple dans un < résumé > ou < remarques > bloc fait référence à un paramètre. Le fichier XML peut être traité pour formater ce mot d'une façon distincte, comme avec une police en gras ou en italique.

< permission cref="member">description</permission>

L' < autorisation > balise vous permet de documenter l'accès d'un membre. Le La classe PermissionSet vous permet de spécifier l'accès à un membre.

<remarks>description</remarks>

La balise < remarks > est utilisée pour ajouter des informations sur un type, complétant les informations spécifiées par < summary >. Cette information est affichée dans le navigateur objet.

<returns>description</returns>

La balise < returns > doit être utilisée dans commentaire pour une déclaration de méthode pour décrire la valeur de retour.

<see cref="member"/>

La balise < voir > vous permet de spécifier un lien à partir du texte. Utilisez < voir aussi > pour indiquer que le texte doit être placé dans une section Voir aussi. Utilisez l'attribut cref pour créer des hyperliens internes vers des pages de documentation pour les éléments de code.

<seealso cref="member"/>

Le< seealso > balise permet d'indiquer le texte que vous souhaitez voir apparaître dans une section Voir Aussi. Utiliser < voir > pour spécifier un lien dans le texte.

<summary>description</summary>

La balise < summary > doit être utilisée pour décrire un type ou un membre type. Utilisez < remarks > pour ajouter des informations supplémentaires à une description de type. Utilisez L'attribut cref pour activer outils de documentation tels que Sandcastle pour créer des hyperliens internes vers les pages de documentation pour les éléments de code. Le texte de la balise < summary > est la seule source d'information sur le type dans IntelliSense, et est également affiché dans le navigateur objet.

<typeparam name="name">description</typeparam>

La balise < typeparam > doit être utilisée dans le commentaire d'une déclaration générique de type ou de méthode pour décrire un type paramètre. Ajouter une balise pour chaque paramètre type du type générique ou de la méthode. Le texte de la balise < typeparam > sera affiché dans IntelliSense, le rapport web de commentaire de code de navigateur D'objet.

<typeparamref name="name"/>

Utilisez cette balise pour permettre aux utilisateurs du fichier de documentation de formater le mot de manière distincte, par exemple en italique.

<value>property-description</value>

Le< valeur > tag vous permet de décrire la valeur qu'une propriété représente. Notez que lorsque vous ajoutez une propriété via l'Assistant code dans L'environnement de développement Visual Studio.net, il ajoutera une balise < summary > pour la nouvelle propriété. Vous devez ensuite ajouter manuellement une balise < value > pour décrire la valeur que la propriété représente.

faire des commentaires XML, comme ceci

/// <summary>
/// This does something that is awesome
/// </summary>
public void doesSomethingAwesome() {}

ceux-ci sont appelés commentaires XML . Ils font partie de Visual Studio depuis toujours.

vous pouvez faciliter votre processus de documentation en utilisant GhostDoc , un add-in Gratuit pour Visual Studio qui génère des commentaires XML-doc pour vous. Il suffit de placer votre caret sur la méthode/propriété que vous voulez documenter, et appuyez sur Ctrl-Shift-D.

Voici un exemple de un de mes messages .

Espère que cela aide :)

utiliser /// pour commencer chaque ligne du Commentaire et faire en sorte que le commentaire contienne le xml approprié pour le lecteur de métadonnées.

///<summary>
/// this method says hello
///</summary>
public void SayHello();

bien que personnellement, je crois que ces commentaires sont généralement mal orientés, à moins que vous développiez des classes où le code ne peut pas être lu par ses consommateurs.

dans CSharp, si vous créez le contour méthode/fonction avec ses Parms, alors quand vous ajoutez les trois slashs avant il générera automatiquement la section summary et parms.

donc j'ai mis:

public string myMethod(string sImput1, int iInput2)
{
}

j'ai alors mis les trois /// avant et Visual Studio m'a donné ceci:

/// <summary>
/// 
/// </summary>
/// <param name="sImput1"></param>
/// <param name="iInput2"></param>
/// <returns></returns>
public string myMethod(string sImput1, int iInput2)
{
}

lire http://msdn.microsoft.com/en-us/library/3260k4x7.aspx le simple fait de spécifier les commentaires n'affichera pas les commentaires d'aide dans intellisense.

définissez des méthodes comme celle-ci et vous obtiendrez l'aide dont vous avez besoin.

    /// <summary>
    /// Adds two numbers and returns the result
    /// </summary>
    /// <param name="first">first number to add</param>
    /// <param name="second">second number to </param>
    /// <returns></returns>
    private int Add(int first, int second)
    {
        return first + second;
    }

Capture d'écran de l'utilisation de code de

aussi l'add-in Visual studio ghost doc tentera de créer et remplir les commentaires d'en-tête à partir de votre nom de fonction.

toutes ces autres réponses ont du sens, mais sont incomplètes. Visual Studio traitera les commentaires XML, mais vous devez les activer. Voici comment faire:

Intellisense utilisera les commentaires XML que vous entrez dans votre code source, mais vous devez les activer par le biais des Options Visual Studio. Aller à Tools > Options > Text Editor . Pour Visual Basic, activez le réglage Advanced > Generate XML documentation comments for ''' . Pour C#, activez le Advanced > Generate XML documentation comments for /// paramètre. Intellisense utilisera les commentaires sommaires lorsqu'ils seront entrés. Ils seront disponibles dans d'autres projets après la compilation du projet référencé.

pour créer la documentation externe , vous devez générer un fichier XML par l'intermédiaire de la Project Settings > Build > XML documentation file: chemin qui contrôle l'option /doc du compilateur. Vous aurez besoin d'un outil externe qui prendra le fichier XML comme entrée et générera la documentation dans votre choix des formats de sortie.

soyez conscient que la génération du fichier XML peut considérablement augmenter votre temps de compilation.

Solmead a la bonne réponse. Pour plus d'informations, vous pouvez regarder commentaires XML .