代码注释规范之Doxygen

Posted 2022-04-04 silencehuan

1.Doxygen简介

Doxygen是一个程序的文档产生工具，可以将程序中的注释转换成说明文档或者说是API参考手册，从而减少程序员整理文档的时间。当然这里程序中的注释需要遵循一定的规则书写，才能让Doxygen识别和转化。

目前Doxygen可处理的程序语言包含C/C++、Java、Objective-C、IDL等，可产生出来的文档格式有html、XML、LaTeX、RTF等，此外还可衍生出不少其它格式，如HTML可以打包成CHM格式，而LaTeX可以通过一些工具产生出PS或是PDF文档等。
2.

2.Doxygen安装及使用

安装列表：

Doxygen： 下载地址，http://doxygen.nl/files/doxygen-1.8.15-setup.exe

HTML Help：微软官方用于生成HTML格式的help文件，下载地址，http://go.microsoft.com/fwlink/p/?linkid=14188

Graphviz：一种dot工具可以用来渲染出效果更好的图表，下载地址，https://graphviz.gitlab.io/_pages/Download/Download_windows.html

windows上安装很简单，无需特别设置。

2.1 Doxygen设置

1.向导

2.专家设置

2.1 Project

每个配置项均有详细鼠标放置时均有详细注释，以下是我的设置可供参考，特别注意语言，避免中文乱码

2.2 Build

EXTRACT_ALL 表示：输出所有的函数，但是private和static函数不属于其管制。

EXTRACT_PRIVATE 表示：输出private函数。

EXTRACT_STATIC 表示：输出static函数。同时还有几个EXTRACT，相应查看文档即可。

HIDE_UNDOC_MEMBERS表示：那些没有使用doxygen格式描述的文档（函数或类等）就不显示了。当然，如果EXTRACT_ALL被启用，那么这个标志其实是被忽略的。

INTERNAL_DOCS 主要指：是否输出注解中的@internal部分。如果没有被启动，那么注解中所有的@internal部分都将在目标帮助中不可见。

CASE_SENSE_NAMES 表示：是否关注大小写名称，注意，如果开启了，那么所有的名称都将被小写。对于C/C++这种字母相关的语言来说，建议永远不要开启。

HIDE_SCOPE_NAMES 表示：域隐藏，建议永远不要开启。

SHOW_INCLUDE_FILES 表示：是否显示包含文件，如果开启，帮助中会专门生成一个页面，里面包含所有包含文件的列表。

INLINE_INFO ：如果开启，那么在帮助文档中，inline函数前面会有一个inline修饰词来标明。

SORT_MEMBER_DOCS ：如果开启，那么在帮助文档列表显示的时候，函数名称会排序，否则按照解释的顺序显示。

GENERATE_TODOLIST ：是否生成TODOLIST页面，如果开启，那么包含在@todo注解中的内容将会单独生成并显示在一个页面中，其他的GENERATE选项同。

SHOW_USED_FILES ：是否在函数或类等的帮助中，最下面显示函数或类的来源文件。

SHOW_FILES ：是否显示文件列表页面，如果开启，那么帮助中会存在一个一个文件列表索引页面。

2.3 input

2.4 Source Browser

2.5 HTML

2.6 Dot

---

 

3 Run 点击运行即可

生成文件在工程 /doc/html/ble_app_gnt.chm

效果如下：