[Resolvido] Padrão de documentação C++

4 respostas
D

Quando aprendi Java lembro do padrão Javadoc para documentação de código e outros para escrita de código como JavaBean, atualmente estou trabalhando com C++ e gostaria de saber se há algum padrão de documentação de código.

Alguém conhece padrões de documentação de código C++ e pode citalos?

4 Respostas

B

DavidUser:
Quando aprendi Java lembro do padrão Javadoc para documentação de código e outros para escrita de código como JavaBean, atualmente estou trabalhando com C++ e gostaria de saber se há algum padrão de documentação de código.

Alguém conhece padrões de documentação de código C++ e pode citalos?

Doxygen

D

Valeu bombbr está ótimo pra mim.

V

No C++, infelizmente, não existe esse padrão.

Você vai ver que o doxygen implementa diversos padrões, inclusive um muito similar ao javadoc.

E

///


///

Eu acabei usando o padrão da Microsoft (argh) porque eu posso usar o Doxygen e o Visual Studio.
Se usasse o padrão JavaDoc, eu só posso usar o Doxygen para processar os meus fontes.
Se olharem bem, o padrão da Microsoft é uma variação do padrão JavaDoc.
Não que o Doxygen seja ruim, mas para o C++ às vezes, dependendo do tipo de fontes que você tem (principalmente se forem aqueles fontes parcialmente gerados pelos wizards do Visual Studio), é um bocadinho difícil fazê-lo funcionar corretamente.
Isso é porque ele não é exatamente um compilador C++, mas quase, e o “quase” acaba fazendo com que você tenha de indicar ao Doxygen que construções são na verdade macros esdrúxulas do Visual Studio que são necessárias.

Criado 20 de maio de 2012
Ultima resposta 21 de mai. de 2012
Respostas 4
Participantes 4