如何做doxygen文档?

如何做doxygen文档?

我的老板告诉我用doxygen.我谷歌了一下,发现你可以codes在 doxygen 中做文档,但是没有代码的详细信息和文本文档呢?

答案1

首先,安装 doxygen(我确定您的操作系统发行版有一个软件包)。然后,在源树的顶层目录中运行:

doxywizard Doxyfile

这为您提供了一种创建 Doxyfile 的简单方法,它本质上是一组有关您希望 doxygen 如何继续进行的说明。我喜欢将其配置为输出到子目录,例如doc/html.

然后在源代码中添加一些 doxygen 注释。您必须使用以下内容对文件顶部进行注释:

//! \file myfile.h This is my header file

然后用以下方式注释各个符号:

//! This is my function:
void function();

还有其他语法,如下所述: http://www.doxygen.nl/manual/docblocks.html#specialblock

然后运行:

doxygen

它将创建您的文档。启动网络浏览器。

哦,如果您想要不包含源代码的文档文件,没问题。您可以配置 doxygen 来识别以.md.只要确保*.md它在您的 FILE_PATTERNS 中即可。您还可以将 USE_MDFILE_AS_MAINPAGE 设置为 Markdown 文件,以从 Markdown 创建首页。这些指令位于您的 Doxyfile 中,但您也可以从向导中编辑它们。

相关内容