☰

如何查看.cpp 文件的“内联文档”？

tag-icon • tag-icon documentation comments
如何查看.cpp 文件的“内联文档”？

我的 cpp 文件在每个函数前都加了如下注释：

/**
 *  @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.
 */

我从格式中推测，必须有某种方法将其导出为“友好”格式，可能是 html，然后可以以类似于 Java API 的方式读取。我该怎么做？

（我使用的是 Windows 7，运行的是 MS Visual Studio 2010）

答案1

您引用的特定文档注释样式几乎肯定是为了处理氧自由基。它可以从许多 C 类语言源代码中的注释生成多种输出格式的高质量文档。还有插件可用于处理某些非 C 语言中的注释，以便包含在同一文档中。

如果你有 AT&TGraphviz工具安装并配置 Doxygen 以使用它们，那么它还可以从源代码中绘制许多有用的图表以包含在文档中。

如果项目使用 Doxygen，那么几乎肯定有一个配置文件，指定要包含哪些源文件、要生成哪些格式以及与详细处理相关的选项。它很可能被命名为doxyfile或类似名称。

常见的输出格式是完整网站的 HTML。网上提供的一个例子是 Doxygen 本身的网站，它几乎完全是通过在其源代码树中运行 Doxygen 生成的。

相关内容