Como se visualiza os "documentos em linha" de um arquivo .cpp?


1

Eu tenho arquivos cpp repletos de comentários como os seguintes antes de cada função:

/**
 *  @brief Set the normal and expansion handshake timeouts.
 *
 *  @param wm               Array of wiimote_t structures.
 *  @param wiimotes         Number of objects in the wm array.
 *  @param normal_timeout   The timeout in milliseconds for a normal read.
 *  @param exp_timeout      The timeout in millisecondsd to wait for an expansion handshake.
 */

Suponho que, a partir do formato, tenha que haver alguma maneira de exportar isso para um formato "amigável", talvez html, que possa ser lido de maneira semelhante à API Java. Como eu faria isso?

(Estou no Windows 7, executando o MS Visual Studio 2010)

Respostas:


3

O estilo de comentário do documento específico que você cita é quase certamente destinado ao processamento pelo Doxygen . Ele pode gerar documentação de qualidade decente em vários formatos de saída, a partir de comentários em fontes de muitos idiomas semelhantes a C. Também existem plugins disponíveis para processar comentários em alguns idiomas não C para inclusão no mesmo documento.

Se você tiver as ferramentas AT&T Graphviz instaladas e configurar o Doxygen para usá-las, também poderá desenhar vários diagramas úteis do código-fonte para inclusão na documentação.

Se o projeto estiver usando o Doxygen, é quase certo que haja um arquivo de configuração que especifique quais arquivos de origem incluir, quais formatos gerar e opções relacionadas ao processamento detalhado. Provavelmente seria nomeado doxyfileou algo semelhante.

Um formato de saída comum é o HTML para um site completo. Um exemplo disponível on-line é o site do Doxygen, que é quase inteiramente gerado pela execução do Doxygen em sua árvore de fontes.


Eu recomendo o Doxygen para projetos escritos em idiomas do tipo C. A disciplina de escrever comentários "suficientemente bons" geralmente é útil e fornece uma declaração clara do "contrato" que cada função está oferecendo para cumprir.
RBerteig
Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.