工控论坛

 找回密码
 注册

QQ登录

只需一步,快速开始

查看: 1|回复: 0

你的代码可以规范到什么程度?Doxygen软件应用

[复制链接]

194

主题

197

帖子

24

积分

初级会员

Rank: 2

工控币
24
发表于 2020-5-20 02:02:24 | 显示全部楼层 |阅读模式
你的代码可以规范到什么程度?为什么stm32官方历程那样编写注释
那么首先我们来看一个软件帮助文档:由于篇幅我们截取几张简单的图片
213543nza8ezgeaexh37hg.png
213620iejydyejj5z0zoj5.png
213647y49rmee7hzzxtir5.png

是的,嵌入式单片机也可以这样写注释,文件引用关系、文件成员列表、成员函数和成员变量、类继承关系图等等等等都可以显示出来
其实这个例子就是STM32官方库函数,他就是这样做的,代码注释符合Doxygen规范,所以可以产生简单易懂的帮助文件。我们可以随便找一个可文件查看效果相同。

Doxygen
Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc兼容。Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参考手册。
Doxygen能将程序中的特定批注转换成为说明文件。它可以依据程序本身的结构,将程序中按规范注释的批注经过处理生成一个纯粹的参考手册,通过提取代码结构或借助自动生成的包含依赖图(include dependency graphs)、继承图(inheritancediagram)以及协作图(collaboration diagram)来可视化文档之间的关系,Doxygen生成的帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML等。

HTML Help WorkShop
微软出品的HTML Help WorkShop是制作CHM文件的最佳工具,它能将HTML文件编译生成CHM文档。
Doxygen软件默认生成HTML文件或Latex文件,我们要通过HTML生成CHM文档,需要先安装HTML Help WorkShop软件,并在Doxygen中进行关联。 软件的下载链接,使用方法请参考附件。

Doxygen代码注释规范.docx

 可以先预览文档前3页,然后再选择下载 
Doxygen代码注释规范.docx (1.5 MB, 售价: 1 工控币)
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 注册

本版积分规则

免责声明: 工控技术网(www.eleok.com)所有内容均为网友自行发布,不代表网站立场。如有版权纠纷,请联系本站删除:1370723259@qq.com

QQ|小黑屋|手机版|工控技术网 |网站地图

GMT+8, 2020-8-12 12:14

Powered by Discuz! X3.4

Copyright © 2001-2020, Tencent Cloud.

快速回复 返回顶部 返回列表