Auto gerar a documentação função no Visual Studio

Question

Eu queria saber se existe uma maneira (espero atalho de teclado) para criar auto gerar cabeçalhos de função no estúdio visual.

Exemplo:

Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)

E seria automagicamente se tornar algo assim ...

'---------------------------------- 
'Pre: 
'Post:
'Author: 
'Date: 
'Param1 (String): 
'Param2 (Integer): 
'Summary: 
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)

Answer 1

Faça que "três comentário marcadores single"

Em C # É ///

que, como espetos padrão out:

/// <summary>
/// 
/// </summary>
/// <returns></returns>

Aqui está algumas dicas sobre a edição de modelos VS .

Answer 2

GhostDoc !

Clique com o botão direito do mouse sobre a função, selecione "Documento isso" e

private bool FindTheFoo(int numberOfFoos)

se torna

/// <summary>
/// Finds the foo.
/// </summary>
/// <param name="numberOfFoos">The number of foos.</param>
/// <returns></returns>
private bool FindTheFoo(int numberOfFoos)

(sim, tudo é gerada automaticamente).

Tem suporte para C #, VB.NET e C / C ++. É por padrão mapeado para Ctrl + Mudança + D .

Lembre-se: você deve adicionar informações além da assinatura do método para a documentação. Não basta parar com a documentação gerada automaticamente. O valor de uma ferramenta como esta é que ele gera automaticamente a documentação que pode ser extraído a partir da assinatura do método, de modo que qualquer informação que você adicionar deve ser novo informações.

Dito isto, eu pessoalmente prefiro quando os métodos são totalmente selfdocumenting, mas às vezes você terá de codificação de normas de que a documentação mandato de fora, e, em seguida, uma ferramenta como isso vai lhe poupar um monte de digitação braindead.

Answer 3

///

é o atalho para obter o Método Descrição bloco de comentário. Mas certifique-se que você tenha escrito o nome da função e assinatura antes de adicionar-lo. Primeiro escrever o nome da função e assinatura.

Em seguida, acima do nome da função basta digitar ///

e você receberá automaticamente

Answer 4

Visual Assist tem uma href="http://www.wholetomato.com/products/features/documentMethod.asp" solução agradável também, e é altamente costumizable.

Depois de ajustar-lo para gerar comentários no estilo doxygen, estes dois cliques produziria -

/**
* Method:    FindTheFoo
* FullName:  FindTheFoo
* Access:    private 
* Qualifier:
* @param    int numberOfFoos
* @return   bool
*/
private bool FindTheFoo(int numberOfFoos)
{

}

(Sob configurações padrão, é um pouco diferente.)

---

Edit: A maneira de personalizar o 'método documento' texto está sob VassistX-> Visual Assist Opções-> Sugestões, selecione 'Editar VA Snippets', Idioma: C ++, Tipo: Refactoring, em seguida, vá para 'Método documento' e personaliza. O exemplo acima é gerado por:

Answer 5

Normalmente, o Visual Studio cria automaticamente se você adicionar três comentário marcadores individuais acima da coisa que você gostaria de comentar (método, classe).

Em C # isso seria /// .

Se o Visual Studio não fizer isso, você pode habilitá-lo no

Opções> Texto Editor-> C # -> Avançado

e verificação

Gerar comentários da documentação XML para ///

Answer 6

No Visual Basic, se você criar a sua função / sub primeiro, em seguida, na linha acima dela, você digita "três vezes, ele irá gerar automaticamente o xml relevante para a documentação. Isso também aparece quando você mouseover no intellisense, e quando você está fazendo uso da função.

Answer 7

Você pode usar trechos de código para inserir todas as linhas que você deseja.

Além disso, se você digitar três aspas simples ( '' ') na linha de cima do cabeçalho da função, ele irá inserir o modelo de cabeçalho XML, que você pode preencher.

Estes comentários XML pode ser interpretado pelo software de documentação, e eles são incluídos na saída da compilação como um arquivo assembly.xml. Se você mantiver esse arquivo XML com a DLL e referência que DLL em outro projeto, esses comentários tornam-se disponíveis no intellisense.

Answer 8

Eu estou trabalhando em um projeto de código aberto chamado Todoc que analisa palavras para produzir uma saída documentação adequada automaticamente ao salvar um arquivo. Respeita os comentários existentes e é muito rápido e fluido.

http://todoc.codeplex.com/