代码注释规范之Doxygen

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

效果如下:

原文地址:https://www.cnblogs.com/silencehuan/p/11169084.html

时间: 2024-08-10 15:27:53

代码注释规范之Doxygen的相关文章

PHPDocumentor代码注释规范说明

   PHPDocumentor是一个的用PHP写的道具,对于有规则注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档. 标记 用途 描述 @abstract   抽象类的变量和方法 @access public, private or protected 文档的访问.使用权限. @access private 表明这个文档是被保护的. @author 张三 <[email protected]> 文档作者 @copyright 名称 时间 文档版权信息 @deprecate

java代码注释规范-----转载-----http://blog.csdn.net/shiyuezhong/article/details/8205281/

1 代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率.也是程序代码可维护性的重要环节之一.所以我们不是为写注释而写注释.下面说一下我们在诉求网二期开发中使用的代码注释规范,供大家参考下. 2 3 原则: 4 1.注释形式统一 5 6 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释.如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范. 7 8 2.注释内容准确简洁 9 10 内容要简单.明了.含

js/javascript代码注释规范与示例

注释在代码编写过程中的重要性,写代码超过半年的就能深深的体会到.没有注释的代码都不是好代码.为了别人学习,同时为了自己以后对代码进行‘升级’,看看js/javascript代码注释规范与示例.来自:http://www.56.com/style/-doc-/v1/tpl/js_dev_spec/spec-comment.html 文件注释 文件注释位于文件的最前面,应包括文件的以下信息:概要说明及版本(必须)项目地址(开源组件必须)版权声明(必须)开源协议(开源组件必须)版本号(必须)修改时间(

代码注释规范

代码注释规范 一. 注释规范 1. 修改代码时,总是使代码的注释保持最新, 为了防止问题反复出现,对错误修复和解决方法代码必须使用注释. 2. 在每个函数.方法的开始,应该提供标准的注释以指示例程的用途,注释样本应该是解释它为什么存在和可以做什么的简短介绍. 3. 避免在代码行的末尾添加注释:行尾注释使代码更难阅读. 4. 在变量声明时,应在行尾添加注释:在这种情况下,将所有行尾注释应使用公共制表符(Tab)在一处对齐. 5. 避免杂乱的注释,如一整行星号.而是应该使用空白将注释同代码分开. 6

PHPDocument 代码注释规范总结

PHPDocument 代码注释规范 1. 安装phpDocumentor(不推荐命令行安装)在http://manual.phpdoc.org/下载最新版本的PhpDoc放在web服务器目录下使得通过浏览器可以访问到点击files按钮,选择要处理的php文件或文件夹还可以通过该指定该界面下的Files to ignore来忽略对某些文件的处理.然后点击output按钮来选择生成文档的存放路径和格式.最后点击create,phpdocumentor就会自动开始生成文档了. 2.如何写PHP规范注

自动化测试代码注释规范

原文链接:http://www.cnblogs.com/zishi/p/6857606.html 一.页头加入代码说明块,格式如下: /************************** *@file *@author XXXXXX *@remarks Modified by XXXXXX *@version *@Modified at 2017/12/6 *@Copyright ? 2012 All Rights Reserved. ***************************/

java开发规范总结_代码注释规范

规范需要平时编码过程中注意,是一个慢慢养成的好习惯 1.基本规则 1.注释应该使代码更加清晰易懂   2.注释要简单明了,只要提供能够明确理解程序所必要的信息就可以了.如果注释太复杂说明程序需要修改调整,使设计更加合理.   3.注释不仅描述程序做了什么, 还要描述为什么要这样做,以及约束   4.对于一般的getter.setter方法不用注释   5.注释不能嵌套   6.生成开发文档的需要用中文编写 2.三种注释方式说明 1.文档注释 /** */ 可以对用多行,一般用来对类.接口.成员方

java代码注释规范

1.单行(single-line)注释:“//……” 2.块(block)注释:“/*……*/” 3.文档注释:“/**……*/” 4.javadoc 注释标签语法 @author   对类的说明 标明开发该类模块的作者 @version   对类的说明 标明该类模块的版本 @see     对类.属性.方法的说明 参考转向,也就是相关主题 @param    对方法的说明 对方法中某参数的说明 @return   对方法的说明 对方法返回值的说明 @exception  对方法的说明 对方法可

给php代码添加规范的注释phpDocumentor

给php代码添加规范的注释更多参考 http://phpdoc.org/docs/latest/index.html在phpdocumentor中,注释分为文档性注释和非文档性注释.所谓文档性注释,是那些放在特定关键字前面的多行注释,特定关键字是指能够被phpdoc分析的关键字,例如class,var等,具体的可参加附录1.那些没有在关键字前面或者不规范的注释就称作非文档性注释,这些注释将不会被phpdoc所分析,也不会出现在你产生的api文当中.3.2如何书写文档性注释:所 有的文档性注释都是