c - 如何像基于 Unix 的 man 手册一样记录源代码功能？

Question

就像当您在源文件中记录函数一样，很难将所有这些文档放入代码文件中，我需要的是在另一个文档工具中拥有干净的源代码文件和文档引用，该工具编译并呈现源代码和文档整齐。这可能吗？如何实现？

Answer 1

我假设您正在使用基于 Unix 的系统并且想要记录 C 源代码。

使用 doxygen (http://www.doxygen.nl/index.html)。

我不确定为什么您不希望源文件中包含文档，但是 doxygen 允许您将接口(interface) (.h) 和实现 (.c) 的文档分开)为您的项目干净地创建文件。它使用 C 风格的注释来生成文档。它不需要太多杂乱的注释，因此它们可以在源代码中独立使用(即无需生成文档)。

安装 doxygen 后，创建项目目录并运行 $ doxygen -g 来创建 Doxyfile。这是您的文档的配置文件。这允许您指定文档格式选项，例如 HTML、Unix 手册页、PDF、RTF 等。