C 如何记录源代码函数,如基于Unix的man手册?

C 如何记录源代码函数,如基于Unix的man手册?,c,documentation,project-management,documentation-generation,code-documentation,C,Documentation,Project Management,Documentation Generation,Code Documentation,就像在源文件中记录函数一样,很难将所有这些文档都放在代码文件中,我需要的是在另一个文档工具中有一个干净的源代码文件,其中包含文档引用,该工具可以整齐地编译和显示源代码和文档。这有可能吗?怎么可能?我假设您使用的是基于Unix的系统,并且希望记录C源代码 使用doxygen() 我不确定您为什么不希望在源文件中包含文档,但doxygen允许您将项目的接口(.h)和实现(.c)文件的文档清晰地分开。它使用C风格的注释生成文档。它不需要太多的注释,因此可以在源代码中单独使用它们(也就是说,不需要生成文

就像在源文件中记录函数一样,很难将所有这些文档都放在代码文件中,我需要的是在另一个文档工具中有一个干净的源代码文件,其中包含文档引用,该工具可以整齐地编译和显示源代码和文档。这有可能吗?怎么可能?

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

使用doxygen()

我不确定您为什么不希望在源文件中包含文档,但doxygen允许您将项目的接口(.h)和实现(.c)文件的文档清晰地分开。它使用C风格的注释生成文档。它不需要太多的注释,因此可以在源代码中单独使用它们(也就是说,不需要生成文档)


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

结合Makefile,您可以轻松地从命令行生成文档并编译源代码。Doxygen不会编译您的代码。