Como alguém visualiza os “documentos in-line” de um arquivo .cpp?

Question

Eu tenho arquivos cpp recheados 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.
 */

Eu assumo no formato que tem que haver alguma maneira de exportar isso para um formato "amigável", talvez html, que pode então ser lido de maneira similar à API Java. Como eu faria isso?

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

    

Answer 1

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

Se você tem as ferramentas AT & T Graphviz instaladas e configura o Doxygen para usá-las, também pode desenhar uma série de diagramas do código-fonte para inclusão na documentação.

Se o projeto estiver usando o Doxygen, há quase certamente um arquivo de configuração que especifica quais arquivos de origem incluir, quais formatos gerar e opções relacionadas ao processamento detalhado. Provavelmente seria nomeado doxyfile , ou algo similar.

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 código.