doxygen小试牛刀

2024-01-31 19:32
文章标签 小试牛刀 doxygen

本文主要是介绍doxygen小试牛刀,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

     今天试用了一下传说中的doxygen,用一句话概括就是:很强大,很方便! 在sourceforge下载了最新版本1.7.2(http://sourceforge.net/projects/doxygen/files/),又在网上找了几篇介绍文档,就开工研究了。总的来说,应用其GUI的配置向导很方便,下面把小试牛刀的应用心得小结如下:

 

(1)将其所有默认的UTF-8编码,替换成GBK,以支持中文的正确显示;

 

(2)记得勾选生成chm的配置选项,并检查编译路径,如下所示:

 

GENERATE_HTMLHELP = YES

HHC_LOCATION           = "C:/Program Files/HTML Help Workshop/hhc.exe"

 

 

(3)doxygen支持生成的文档格式有:

l         HTML

l         XML

l         LaTeX

l         RTF

l         Unix Man Page

 

 

(4)比较常用的配置选项:

 

 

INPUT                  = . ../include         项目的路径(用空格隔开,可以用引号括起来)

HIDE_UNDOC_MEMBERS     = NO             是否需要隐藏未注释的成员

SOURCE_BROWSER         = YES             是否显示源程序

GENERATE_HTML          = YES               生成html格式的文档

GENERATE_HTMLHELP      = YES             生成chm文件

CHM_FILE               = show.chm         chm文件的名字

HHC_LOCATION           = "C:/Program Files/HTML Help Workshop/hhc.exe"            hhc的路径

HAVE_DOT                      = YES                      支持图形扩展

 

 

(5)为了能够使用Dot图形扩展,你需要首先安装graphviz,这是一个免费的图形库扩展,可以从http://graphviz.org 下载。下载完Dot并安装完毕之后,需要在doxygen文件中将以下选项打开:

     HAVE_DOT = YES

  

      总之,有了doxygen的支持后,从软件代码到项目文档的转化十分简单,在源码文件中按指定格式写好注释,然后,运行一下doxygen代码的说明文档就方便快捷的输出了。这对于一些中、大型多人协作开发的项目,尤其有用!

 

 

 

 

 

 

 

这篇关于doxygen小试牛刀的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/664825

相关文章

在 Qt Creator 中,输入 /** 并按下Enter可以自动生成 Doxygen 风格的注释

在 Qt Creator 中,当你输入 /** 时,确实会自动补全标准的 Doxygen 风格注释。这是因为 Qt Creator 支持 Doxygen 以及类似的文档注释风格,并且提供了代码自动补全功能。 以下是如何在 Qt Creator 中使用和显示这些注释标记的步骤: 1. 自动补全 Doxygen 风格注释 在 Qt Creator 中,你可以这样操作: 在你的代码中,将光标放在

MutationObserver小试牛刀

参考文档 https://developer.mozilla.org/zh-CN/docs/Web/API/MutationObserver 简介 MutationObserver 接口提供了监视对 DOM 树所做更改的能力。 MutationObserver() 构造函数——是 MutationObserver 接口内容的一部分——创建并返回一个新的观察器,它会在触发指定 DOM 事件时,

NodeJs小试牛刀--聊天室搭建

最近研究聊天室功能,准备用nodejs实现。下面是自己的尝试!! nodejs的安装这里就不详细赘述了。 程序创建 引入required模块 var express = require('express');var app = express();var http = require('http').Server(app); 创建监听端口 http.listen(8000, f

iPhone开发之UITableView的小试牛刀 利用MVC模式从plist文件读取数据并字典转模型的格式实现

新建一个具有simple  VIew的工程,并把相关图片拉进资源文件夹 在Supporting  files文件夹下新建work.plist文件,编辑内容如下图: 在工程下新建model文件夹,并在文件夹内新建model类Hero 根据文件的字典属性编辑Hero.h如下: //// Hero.h// 作业整理//// Created by apple on 15/

Xcode4快速Doxygen文档注释 — 简明图文教程

准备2个文件: 文件一,ThisService.app 文件二,Doxygen.rb 下载上述2个文件: ThisService&Doxygen_rb 准备好之后,两步配置,一步操作: 配置一, 打开ThisService,如上图, Name随意填写,将来会出现在右键菜单,红框1 把Doxygen.rb拽到红框2, 选Filter(both),红框3 然后Crea

OrangePi AIpro小试牛刀-目标检测(YoloV5s)

非常高兴参加本次香橙派AI Pro,香橙派联合华为昇腾打造的一款AI推理开发板评测活动,以前使用树莓派Raspberry Pi4B 8G版本,这次有幸使用国产嵌入式开发板。 一窥芳容 这款开发板搭载的芯片是和华为昇腾的Atlas 200I DK A2同款的处理器,功耗低至8W 默认AI CPU和Control CPU 比例1:3, 芯片名称 310B1:表示芯片算

linux下使用doxygen和grapviz生成函数调用关系图

1,参考链接 https://jasoncc.github.io/doc_tools/doxygen.html 2,操作流程 以ubuntu为例,执行如下命令来生成doxygen $ sudo apt-get install doxygen$ sudo apt-get install graphviz$ mkdir /tmp/doxygen && cd /tmp/doxygen$

doxygen 1.11.0 使用详解(九)——包含公式

目录 Doxygen allows you to put LATEX formulas in the output (this works only for the HTML, LATEX and RTF output. To be able to include formulas (as images) in the HTML and RTF documentation, you

Doxygen极简使用说明

<?xml version="1.0" encoding="utf-8"?> Doxygen Table of Contents 1. Introduction2. Syntax 2.1. 简要描述2.2. 函数描述2.3. 行尾注释2.4. 对于生成格式的说明 3. Application 1 Introduction Doxygen是一种开源的,跨平台的,以类似Javadoc风