Há algo como GhostDoc para C ++

Question

Quando eu estou desenvolvendo em C #, eu fortemente usar GhostDoc para acelerar o processo de comentar meu código. Atualmente estou trabalhando em um projeto C ++ e eu não encontrei uma ferramenta equivalente. Eu sei sobre Doxygen, mas pelo que eu sei que é usado para criar documentação fora do código, não comenta no código. Há alguma boas ferramentas equivalentes? Eu preferiria um que é executado em VS, mas eu poderia lidar com um que funcione em qualquer IDE.

(Antes que alguém traz-lo, eu não confiar apenas em GhostDoc para criar comentários. Eu só usá-lo para criar o ponto de partida para os meus comentários.)

Answer 1

Visual Assist ajuda fornecendo scripts personalizados executados durante a digitação (ou em outro).

Por exemplo, você pode ter um script para comentários como este:

/************************************************************************/
/* My comment : $end$                                                                     */
/************************************************************************/

Isso seria sugerido (através de uma caixa de combinação exatamente como intellisense) quando você começar a digitar "/ **", por exemplo. Ao selecionar esta sugestão (via Enter / Espaço / Clique - customizáveis), ele irá inserir o script onde está o cursor e apenas substituir marcadores que estão entre os caracteres '$' por valores especiais (como o nome do arquivo atual, por exemplo). Aqui o $ end $ marcador fará com que o cursor se nesta posição quando o script é executado. Dessa forma, você continuar a escrever sem problemas. Por exemplo, com o conjunto de script anterior, digitando exatamente:

/** this is a test comment to show you one of the many features Visual Assit!

irá simplesmente dar:

/************************************************************************/
/* My comment : this is a test comment to show you one of the many features Visual Assit!                                                                     */
/************************************************************************/

É muito fácil de personalizar e o comportamento da sugestão (leia-se: intellisense ++). Sistema é personalizável

Answer 2

Eu escrevi um add-in, Atomineer Pro Documentação , que é muito semelhante ao GhostDoc (que gera / atualiza os comentários de documentação para salvar um monte de tempo e esforço quando documentando), mas ele analisa o código diretamente para si mesmo e, portanto, é capaz de lidar com C, C ++, C ++ / CLI, C #, Java e código do Visual Basic e não requer o código circundante para estar em um estado de compilar antes que ele irá trabalhar. Ele também irá adicionar automaticamente a documentação / update para coisas mais complicadas, como exceções lançadas dentro do corpo de um método.

Ele é executado em Visual Studio 11, 2010, 2008 e 2005 e suportes de Documentação em XML, Doxygen, JavaDoc e Qt formatos de comentário, bem como o formato / estilo de blocos de comentário e as regras de auto-doc usou ser altamente configurável . Tem uma série de outras funcionalidades úteis, tais como auxiliar conversões de legados doc-observações para os formatos acima, e agrupamento de palavras em doc-observações e comentários normais bloco.

A descrição acima é apenas um resumo de algumas das principais características - Este comparação das características com outros produtos serve como uma lista mais completa dos muitos outros recursos disponíveis.

Answer 3

Visual Assist pode fazer o trabalho, embora eu não estou absolutamente certo.