ICode9

精准搜索请尝试: 精确搜索
首页 > 编程语言> 文章详细

嵌入式系统开发环境的构建13:安装Doxygen生成程序注释文档

2020-02-06 13:41:33  阅读:258  来源: 互联网

标签:文件 13 Doxygen 程序 嵌入式 注释 文档 安装


本系列教程将向大家讲述,在自己的计算机上构建完善的嵌入式系统开发环境的方法。

本文将向大家讲述安装Doxygen生成程序注释文档的方法。

Doxygen简介:

Doxygen 是一个程序的文件产生工具,可将程序中的特定注释转换成为说明文件。通常我们在写程序时,或多或少都会写上注释,但是对于其它人而言,要直接探索程序里的注释,与打捞泰坦尼克号同样的辛苦。大部分有用的注释都是属于针对函数、类型等等的说明。所以,如果能依据程序本身的结构,将注释经过处理重新整理成为一个纯粹的参考手册,对于后面利用您的程序代码的人而言将会减少许多的负担。不过,反过来说,整理文件的工作对于您来说,就是沉重的负担。

对于未归档的源文件,也可以通过配置Doxygen来提取代码结构。或者借助自动生成的包含依赖图(includedependency graphs)、继承图(inheritance diagram)以及协作图(collaborationdiagram)来可视化文档之间的关系。Doxygen生成的帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML和Unixman page等。

一个好的程序设计师,在写程序时,都会在适当的地方加上合适的注释。如果,能够在撰写注释时,稍微符合某种格式,接着就可以透过一个工具程序依据程序结构及您的批注产生出漂亮的文件。这将令许多工作繁重的程序设计师有时间多喝几杯咖啡。

Doxygen 就是这样的一个工具。在您写批注时,稍微按照一些它所制订的规则。接着,他就可以帮您产生出漂亮的文件了。因此,Doxygen 的使用可分为两大部分。首先是特定格式的批注撰写,第二便是利用Doxygen的工具来产生文件。


一、安装步骤

1、从官网下载:http://www.doxygen.nl/download.html

2、双击安装文件运行,同意许可。

3、更改程序安装路径。

4、安装全部选项。

5、设置“开始菜单”文件夹名称。

6、确认安装信息。

7、进行程序安装。

8、进行信息确认。

9、完成安装。

二、使用方法

可参看Git服务器上的程序案例的注解使用方法,在后续阶段,补充此段内容。

 

 

 

 

 

 

 

snmplink 发布了423 篇原创文章 · 获赞 1112 · 访问量 83万+ 他的留言板 关注

标签:文件,13,Doxygen,程序,嵌入式,注释,文档,安装
来源: https://blog.csdn.net/qingwufeiyang12346/article/details/104129602

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有