如何记录源代码函数，如基于Unix的man手册？

Question

就像在源文件中记录函数一样，很难将所有这些文档放在代码文件中，我需要的是在另一个编译和呈现源代码的文档工具中使用文档引用的干净源代码文件。整洁地记录在案。那是可能的吗？

Answer 1

我假设您使用的是基于Unix的系统，并希望记录C源代码。

使用doxygen（http://www.doxygen.nl/index.html）。

我不确定为什么你不想在源文件中包含文档，但doxygen允许你分离界面文档（ .h ）和实现（ .c ）干净利落的项目文件。它使用C风格的注释来生成文档。它不需要太多的注释混乱，因此它们可以在源代码中单独使用（即，没有生成的文档）。

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