ASPICE SWE3之——C代码生成软件详细设计1 Doxygen配置
目录
1 前言
2 Doxygen简介
2.1 什么是Doxygen
2.2 安装Doxygen及辅助软件
2.3 Doxygen的配置
1 前言
前面已经单独一篇文章讲了,若想通过Doxygen工具生成C代码的软件详细设计文档,需要C代码注释的格式,并推荐了注释规范,以满足Doxygen工具识别格式,且符合ASPICE对详细设计的内容要求,且尽可能使注释内容简洁并生成报告好看。
本文接下来讲,若想通过Doxygen工具生成C代码的软件详细设计文档,需要下载哪些软件,软件包放在资源中需要自取,Doxygen工具该如何配置,若想生成报告成功需要注意什么。
配置项上参考了一些网上推荐的配置,使用时仍会出现一些的问题,经过不停尝试,最终生成报告成功,遂又总结了一下这些配置。
2 Doxygen简介
2.1 什么是Doxygen
Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件。可以结合graphviz软件生成函数调用关系图。
2.2 安装Doxygen及辅助软件
1)安装 Doxygen1.9.1
2)安装 graphviz2.38(Windows)
graphviz是一个开源工具包,用于绘制DOT语言脚本描述的图形。Doxygen使用graphviz可自动生成类之间和文件之间的调用关系图。
3)安装 Windows Help Workshop
Doxygen 使用这个工具可以生成CHM格式的文档。
2.3 Doxygen的配置
如果想打开GraphViz的界面,需要进入bin安装目录,找到如下图所示的应用程序,打开运行即可。
所有软件下载安装完成后,打开Doxygen应用程序,位置如下图所示。
1)加载保存好的配置文件Doxygen_demo_config
若加载如上已有配置,仅需再手动配置下面第2、6、9中需要添加路径的步骤。
也可按如下所有步骤进行私人配置后进行保存,方便下次使用。
2)打开Doxygen GUI frontend,按下图所示方法配置
2)指定源码输出模式
3)选择输出文件的格式
4)选择是否使用生成图表的软件包
点击Expert标签(若继续点击next会进入Run)
在选择这个选项之前需要确保先安装了Graphviz工具包。
5)编译的设置
点击Expert标签,进入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 :是否显示文件列表页面,如果开启,那么帮助中会存在一个一个文件列表索引页面。
6)输出的设置
点击Expert标签下的Dot标签后,这里配置我们安装的GraphViz
7)中文版报告设置
若使用英文注释,可不设置该项。
进入Project标签,设置语言为Chinese即可
8)Doxygen支持中文注释的方法
以下仅提供方法,若使用英文注释,可不设置该项。
Export->Project-> DOXYFILE_ENCODING GBK/GB2312
Export->Input->INPUT_ENCODING GBK/GB2312
9)生成.chm格式的报告
10)开始编译生成html报告
Run标签下,点击 Run Doxygen即可。如下图所示(根据你源代码的大小,等待的时间不同,直到出现finished),最后点击“Show HTML output”可打开HTML格式报告。
11)在报告路径下打开.chm格式的文件
由于HTML格式报告包含太多文件,容易丢失。详设报告使用.chm格式报告,在HTML报告路径下。
ASPICE SWE3之——C代码生成软件详细设计1 Doxygen配置相关推荐
- ASPICE SWE3之——C代码生成软件详细设计2 注释格式
写软件详细设计文档,一般多为有ASPICE要求,写文档真的很费时间,没有要求真的不想写. Doxygen工具就提供了一种通过给代码注释的方式,导出详细设计文档,至于导出什么内容,主要取决于注释的内容. ...
- ASPICE SWE3之——模型生成软件详细设计2 注释格式
目录 前言 注释层级 注释方式 注释格式 功能层(顶层): 时间计划层: 控制流层: 前言 前篇已经说到,使用Matlab的print功能导出模型详细设计,相关的配置.若想生成的详细设计内容完整,格式 ...
- ASPICE SWE3之——模型生成软件详细设计1 配置
目录 1.导出模型软件详细设计的配置: 2.导出的详细设计报告的内容: 前言 同C代码通过工具生成软件详细设计,模型开发也可通过工具导出详细设计. MATLAB有单独用于生成软件详细设计的工具包Sim ...
- repo-话说软件详细设计工具
repost 4 https://blog.csdn.net/tang_huan_11/article/details/8043481 在软件设计是需要写软件详细说明书,设计此文档的时候,肯定少不了工 ...
- 五、软件详细设计说明书-模板
五.软件详细设计说明书 1.引言 1 1.1编写目的 1 1.2项目背景 1 1.3定义 2 1.4参考资料 2 2.总体设计 2 2.1需求概述 2 2.2软件结构 2 3.程序描述 2 3.1功能 ...
- 软件详细设计说明书 模板
软件详细设计说明书 1 引言 1.1 编写目的:阐明编写详细设计说明书的目的,指明读者对象. 1.2 项目背景:应包括项目的来源和主管部门等. 1.3 定义:列出本文档中所用到的专门术语的定义和缩写词 ...
- Nagios远程监控软件的安装与配置详解
Nagios远程监控软件的安装与配置详解 作者:redhat_hu Nagios是一款功能强大的网络监视工具,它可以有效的监控windows.linux.unix主机状态以及路由器交换机的网络设置,打 ...
- 计算机硬件配置和软件有哪些,BIM软件对电脑硬件配置有什么要求?
BIM软件对电脑硬件配置有什么要求?这是很多学习BIM软件的小伙伴经常会提到的问题,BIM主要基于三维工作方式,其建筑模型文件大小从几十MB至上千MB,故对电脑硬件的计算能力和图形处理能力等,都提出很 ...
- 3D-AVS2参考软件RFD10.0的配置
3D-AVS2参考软件RFD10.0的配置 一.用Cmake生成RD.sln解决方案 CMake下载地址:https://cmake.org/download/ 参照README.txt,注意VC版本 ...
最新文章
- boost::log::sinks::synchronous_sink用法的测试程序
- 云游戏之大冒险:5G,等还是不等 | 专访云格致力陈浩
- VMware10出现VMware Workstation 不可恢复错误: (vmx)
- AndroidStudio_安卓原生开发_自定义单选列表Spinner绑定自定义数据类型---Android原生开发工作笔记143
- arrays合并两个数组_九章算法 | 字节跳动面试题:合并k个排序数组
- ​Linux进程管理工具
- 作为字节跳动的研发面试官,有些话我不得不说!
- opencms10.5.1如何汉化
- 磁共振神经根水成像_磁共振神经根水成像鉴别类肿瘤样椎间盘突出症与神经鞘瘤2例...
- ZGF建筑事务所公布波特兰国际机场新航站楼设计方案,木构屋顶展现自然景观
- 【转】C++多继承的细节
- echarts3在Y轴上做基准线
- 六月,授你以鱼,再授你以渔
- [技术讨论]为什么运算放大器有共模输入电压范围限制呢,详解在这里
- 2D-Driven 3D Object Detection in RGB-D Images
- MySQL Workbench构建ER图(实体关系图)
- android AdapterView 关键方法分析
- 在线JADE转HTML工具
- slim android7 nexus7,Nexus 7第二代的CPU是什么
- matlab simu,MathWorks 发布 MATLAB 和 Simulink 版本 2021a
热门文章
- 集成学习 hard/soft Voting,Bagging/Pasting,oob 随机森林
- xp系统服务器的ip地址怎么查,xp怎么配置ip地址|xp系统怎么样查看自己的ip地址...
- macd金叉不涨又死叉准确率_MACD金叉周线选股公式怎么设置及计算
- 2021.12.28同花顺--智能--选股平台----技术指标--其它指标--逍遥买卖宝--指标B
- Catalan 数的应用
- 计算机网络_学习笔记 索引
- 记录谷粒学院的一些问题--------------chapter1
- 灰色模型(GM)的局限浅谈
- java 快速创建map_快速创建 Map
- 数据分析---Fama-French三因子模型