Eu queria saber se existe uma maneira (espero atalho de teclado) para criar cabeçalhos de função de geração automática no Visual Studio.
Exemplo:
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
E se tornaria automagicamente algo assim ...
'----------------------------------
'Pre:
'Post:
'Author:
'Date:
'Param1 (String):
'Param2 (Integer):
'Summary:
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
Respostas:
Faça isso "três marcadores de comentário único"
Em C # é ///
que, por padrão, expõe:
/// <summary>
///
/// </summary>
/// <returns></returns>GhostDoc !
Clique com o botão direito na função, selecione "Documentar" e
private bool FindTheFoo(int numberOfFoos)
torna-se
/// <summary>
/// Finds the foo.
/// </summary>
/// <param name="numberOfFoos">The number of foos.</param>
/// <returns></returns>
private bool FindTheFoo(int numberOfFoos)
(sim, é tudo gerado automaticamente).
Possui suporte para C #, VB.NET e C / C ++. É por padrão mapeado para Ctrl+ Shift+ D.
Lembre-se: você deve adicionar informações além da assinatura do método à documentação. Não pare apenas com a documentação gerada automaticamente. O valor de uma ferramenta como essa é que ela gera automaticamente a documentação que pode ser extraída da assinatura do método, portanto, qualquer informação adicionada deve ser nova .
Dito isso, eu pessoalmente prefiro quando os métodos são totalmente autodocumentados, mas às vezes você terá padrões de codificação que exigem documentação externa e, em seguida, uma ferramenta como esta o poupará de muito trabalho de digitação.
///
é o atalho para obter o bloco de comentários da Descrição do Método. Mas certifique-se de ter escrito o nome da função e a assinatura antes de adicioná-la. Escreva primeiro o nome da função e a assinatura.
Então, acima do nome da função, basta digitar ///
e você receberá automaticamente
O Visual Assist também tem uma boa solução e é altamente personalizável.
Depois de ajustá-lo para gerar comentários no estilo doxygen, esses dois cliques produziriam -
/**
* Method: FindTheFoo
* FullName: FindTheFoo
* Access: private
* Qualifier:
* @param int numberOfFoos
* @return bool
*/
private bool FindTheFoo(int numberOfFoos)
{
}
(Nas configurações padrão, é um pouco diferente.)
Editar: A forma de personalizar o texto do 'método do documento' é em VassistX-> Opções do Visual Assist-> Sugestões, selecione 'Editar trechos VA', Idioma: C ++, Tipo: Refatoração, vá para 'Método do documento' e personalize. O exemplo acima é gerado por:
Normalmente, o Visual Studio o cria automaticamente se você adicionar três marcadores de comentário únicos acima do que deseja comentar (método, classe).
Em C #, isso seria ///.
Se o Visual Studio não fizer isso, você pode habilitá-lo em
Opções-> Editor de Texto-> C # -> Avançado
e verificar
Gere comentários de documentação XML para ///
No visual basic, se você criar sua função / sub primeiro, na linha acima, você digita 'três vezes, ele irá gerar automaticamente o xml relevante para documentação. Isso também aparece quando você passa o mouse sobre o intellisense e quando está usando a função.
Você pode usar trechos de código para inserir as linhas que desejar.
Além disso, se você digitar três aspas simples ('' ') na linha acima do cabeçalho da função, será inserido o modelo de cabeçalho XML que você pode preencher.
Esses comentários XML podem ser interpretados pelo software de documentação e são incluídos na saída do build como um arquivo assembly.xml. Se você mantiver esse arquivo XML com a DLL e fizer referência a essa DLL em outro projeto, esses comentários se tornam disponíveis no intellisense.
Estou trabalhando em um projeto de código aberto chamado Todoc que analisa palavras para produzir saída de documentação adequada automaticamente ao salvar um arquivo. Respeita os comentários existentes e é muito rápido e fluido.