Como tem comentários em IntelliSense para a função no Visual Studio?

Question

No Visual Studio e C #, quando se utiliza um construído em função, como ToString (), mostra IntelliSense uma caixa amarela explicando o que ele faz.

Como posso ter isso para funções e propriedades que escrevo?

Answer 1

Para gerar uma área onde você pode especificar uma descrição para a função e cada parâmetro para a função, digite o seguinte na linha antes de sua função e hit Enter :

• C #: ///

• VB: '''

Consulte Etiquetas recomendadas para comentários da documentação (C # Guia de Programação) para mais informações sobre o conteúdo estruturado você pode incluir nestes comentários.

Answer 2

O que você precisa é de xml comentários - basicamente, eles seguem essa sintaxe (como vagamente descrito por 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

Answer 3

<c>text</c> - O texto que você gostaria de indicar como código
. A tag << em> c > dá-lhe uma maneira de indicar que o texto dentro uma descrição deve ser marcado como código. Use << em> código > para indicar várias linhas como código.

<code>content</code> -. O texto que deseja marcado como código
A tag << em> código > dá-lhe uma forma de indicar várias linhas como código. Use << em> c > para indicar que o texto dentro uma descrição deve ser marcado como código.

<example>description</example> -. A descrição do exemplo de código
A tag << em> exemplo > permite que você especifique um exemplo de como usar um método ou outro membro da biblioteca. Isso geralmente envolve o uso do << em> código >.

<exception cref="member">description</exception> -. A descrição da exceção
A tag << em> exceção > permite especificar quais exceções podem ser geradas. Esta tag pode ser aplicada a definições para métodos, propriedades, eventos e indexadores.

<include file='filename' path='tagpath[@name="id"]' />
A tag << em> incluir > permite que você se refere aos comentários em outro arquivo que descrevem os tipos e membros em seu código fonte. Esta é uma alternativa para colocar comentários de documentação diretamente no seu arquivo de código-fonte. Colocando a documentação em um arquivo separado, você pode aplicar o controle de origem para a documentação em separado do código-fonte. Uma pessoa pode ter o arquivo de código fonte check-out e alguém pode ter o arquivo de documentação check-out. A tag << em> incluir > usa a sintaxe XPath XML. Consulte a documentação XPath para maneiras de personalizar seu << em> incluir > uso.

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

O bloco << em> listheader > é usado para definir a linha de título de uma tabela ou lista de definição. Ao definir uma tabela, você só precisa fornecer uma entrada para o termo no título. Cada item na lista é especificado com um item << em> > bloco. Ao criar uma lista de definição, você precisará especificar prazo e descrição. No entanto, para uma tabela, lista com marcadores ou lista numerada, você só precisa fornecer uma entrada para descrição. A lista ou tabela pode ter tantos << em> item > conforme necessário.

<para>content</para>
O << em> para > tag é para uso dentro de uma tag, como << em> resumo >, << em> observa > ou << em> volta >, e permite-lhe adicionar estrutura ao texto.

<param name="name">description</param>
O << em> param > tag deve ser usada no comentário de uma declaração de método para descrever um dos parâmetros para o método. Para documentar vários parâmetros, uso múltiplo << em> param > tags.
O texto para o << em> param > tag será exibido no IntelliSense, o Object Browser, e no Código Comentário Relatório Web.

<paramref name="name"/>
O << em> paramref > tag dá-lhe uma maneira de indicar que uma palavra nos comentários de código, por exemplo, em um << em> resumo > ou << em> observa > bloco refere-se a um parâmetro. O arquivo XML pode ser processado para formatar esta palavra de alguma forma distinta, como com uma fonte em negrito ou itálico.

<permission cref="member">description</permission>
A tag << em> permissão > permite documentar o acesso de um membro. A classe PermissionSet permite especificar o acesso a um membro.

<remarks>description</remarks>
A tag << em> Observações > é usado para adicionar informações sobre um tipo, completando as informações especificadas com << em> resumo >. Esta informação é exibida no localizador de objectos.

<returns>description</returns>
O << em> volta > deve ser usado no comentário de uma declaração de método para descrever o valor de retorno.

<see cref="member"/>
A tag << em> ver > permite especificar um link de dentro do texto. Use << em> seealso > para indicar que o texto deve ser colocado em um Vide seção também. Use o atributo CREF para criar hiperlinks internos para páginas de documentação para elementos de código.

<seealso cref="member"/>
O << em> seealso > tag permite que você especifique o texto que você pode querer appear em uma seção Consulte também. Use << em> ver > para especificar um link de dentro do texto.

<summary>description</summary>
A tag << em> resumo > deve ser usado para descrever um tipo ou membro tipo. Use << em> Observações > para adicionar informações suplementares para uma descrição tipo. Use o atributo CREF para permitir ferramentas de documentação, como Sandcastle para criar hiperlinks interno para páginas de documentação para elementos de código. O texto para o << em> resumo > é a única fonte de informações sobre o tipo de IntelliSense, e também é exibida no localizador de objectos.

<typeparam name="name">description</typeparam>
O << em> typeparam > tag deve ser usada no comentário a um tipo genérico ou declaração de método para descrever um parâmetro de tipo. Adicionar uma tag para cada parâmetro do tipo do tipo genérico ou método. O texto para o << em> typeparam > tag será exibido no IntelliSense, o relatório comentário de código web localizador de objectos.

<typeparamref name="name"/>
Use esta tag para permitir aos consumidores do arquivo de documentação para formatar a palavra de alguma forma distinta, por exemplo em itálico.

<value>property-description</value>
A tag << em> valor > permite descrever o valor que uma propriedade representa. Note que quando você adiciona uma propriedade via assistente de código no ambiente de desenvolvimento Visual Studio .NET, ele irá adicionar um resumo << em> > tag para a nova propriedade. Você deve então adicionar manualmente um << em> valor > para descrever o valor que a propriedade representa.

Answer 4

Do XML comentando, como este

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

Answer 5

uso /// no começo de cada linha do comentário e têm o comentário conter o xml apropriado para o leitor de dados meta.

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

Embora, pessoalmente, acredito que esses comentários são geralmente equivocada, a menos que você está desenvolvendo classes em que o código não podem ser lidos por seus consumidores.

Answer 6

Those are called XML Comments. They have been a part of Visual Studio since forever.

You can make your documentation process easier by using GhostDoc, a free add-in for Visual Studio which generates XML-doc comments for you. Just place your caret on the method/property you want to document, and press Ctrl-Shift-D.

Here's an example from one of my posts.

Hope that helps :)

Answer 7

In CSharp, If you create the method/function outline with it's Parms, then when you add the three forward slashes it will auto generate the summary and parms section.

So I put in:

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

I then put the three /// before it and Visual Studio's gave me this:

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

Answer 8

read http://msdn.microsoft.com/en-us/library/3260k4x7.aspx Just specifying the comments will not show the help comments in intellisense.

Answer 9

Define Methods like this and you will get the help you need.

    /// <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;
    }

Screenshot of the code usage

Answer 10

Also the visual studio add-in ghost doc will attempt to create and fill-in the header comments from your function name.

Answer 11

All these others answers make sense, but are incomplete. Visual Studio will process XML comments but you have to turn them on. Here's how to do that:

Intellisense will use XML comments you enter in your source code, but you must have them enabled through Visual Studio Options. Go to Tools > Options > Text Editor. For Visual Basic, enable the Advanced > Generate XML documentation comments for ''' setting. For C#, enable the Advanced > Generate XML documentation comments for /// setting. Intellisense will use the summary comments when entered. They will be available from other projects after the referenced project is compiled.

To create external documentation, you need to generate an XML file through the Project Settings > Build > XML documentation file: path that controls the compiler's /doc option. You will need an external tool that will take the XML file as input and generate the documentation in your choice of output formats.

Be aware that generating the XML file can noticeably increase your compile time.

Answer 12

Solmead has the correct answer. For more info you can look at XML Comments.