doxygen 教程 linux,doxygen linux
doxygen linux是一款开源跨平台类似于javadoc风格描述的文档,软件能够让我们的开发人员轻松为自己的应用程序制作各种帮助文档,完全支持C、C++、java、Object-C等语言,还支持部分的PHP、C#等,是一款非常不错的帮助文档生成器。
doxygen linux能够直接从源中提取用户的注释,所以用户的帮助文档能够和源代码保持一致,保证了提取出来的东西能够和源代码保持一致,不管用户后面如何修改代码,最后用户再一次生成帮助文档的时候都会变成最新最准确的内容,用户完全不需要担心出现问题,有需要的程序员可不能够错过这款强大的软件哦。
doxygen linux安装说明1、编译安装
1) tar xvfz doxygen-1.7.4.linux.bin.tar.gz
2) cd doxygen-1.7.4
3) ./configure
4) make
5) make install
2、安装graphviz
1、执行如下命令即可完成安装
yum install graphviz
3、配置使用
1、在项目工程目录下生成配置文件
cd test/ #进入项目目录(test为例说明)
Doxygen –g #生成配置文件
提示:
1、默认生成的配置文件名为 "Doxyfile",也可以指定生成的配置文件名:doxygen -g your-cfg-filename
2、可以在生成配置文件的命令中添加 "-s" 选项,生成不含注释的配置文件:doxygen -sg
3、根据需要,修改配置文件
doxygen linux使用方法
一、程序注释文档化
使用Doxygen,需要按照Doxygen 的游戏规则来对程序源码进行文档化。
Doxygen 的注释类型可分为:
1、行间注释:注释语句不与程序源码出现在同一行,主要用于注释头文件中出现的结构体 (struct)、枚举 (enum)、联合 (uion) 等数据类型,以及程序接口的功能与使用约定;
2、行内注释:注释语句与程序源码出现在同一行内,主要用于代码的局部注释。
二、文档生成
cd test/
doxygen
提示:
可以指定配置文件名:doxygen your-cfg-filename
三、文档使用
生成的文档位于test/doc/html 目录中,使用浏览器打开该目录中的 index.html 文件,即可看到自己的工作成果。
doxygen linux常用选项# 项目名称,将作为于所生成的程序文档首页标题
PROJECT_NAME = “Test”
# 文档版本号,可对应于项目版本号,譬如 svn、cvs 所生成的项目版本号
PROJECT_NUMBER = "1.0.0
# 程序文档输出目录
OUTPUT_DIRECTORY = /home/user1/docs
# 程序文档输入目录
INPUT = /home/user1/project/kernel
# 程序文档语言环境
OUTPUT_LANGUAGE = Chinese
# 只对头文件中的文档化信息生成程序文档
FILE_PATTERNS =
# 递归遍历当前目录的子目录,寻找被文档化的程序源文件
RECURSIVE = YES
# 如果是制作 C 程序文档,该选项必须设为 YES,否则默认生成 C++ 文档格式
OPTIMIZE_OUTPUT_FOR_C = YES
#提取信息,包含类的私有数据成员和静态成员
EXTRACT_ALL = yes
EXTRACT_PRIVATE = yes
EXTRACT_STATIC = yes
# 对于使用 typedef 定义的结构体、枚举、联合等数据类型,只按照 typedef 定义的类型名进行文档化
TYPEDEF_HIDES_STRUCT = YES
# 在 C++ 程序文档中,该值可以设置为 NO,而在 C 程序文档中,由于 C 语言没有所谓的域/名字空间这样的概念,所以此处设置为 YES
HIDE_SCOPE_NAMES = YES
# 让 doxygen 静悄悄地为你生成文档,只有出现警告或错误时,才在终端输出提示信息
QUIET = YES
# 递归遍历示例程序目录的子目录,寻找被文档化的程序源文件
EXAMPLE_RECURSIVE = YES
# 允许程序文档中显示本文档化的函数相互调用关系
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES
# 不生成 latex 格式的程序文档
GENERATE_LATEX = NO
# 在程序文档中允许以图例形式显示函数调用关系,前提是你已经安装了 graphviz 软件包
HAVE_DOT = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES
#在最后生成的文档中,把所有的源代码包含在其中
SOURCE BROWSER = YES
$这会在HTML文档中,添加一个侧边栏,并以树状结构显示包、类、接口等的关系
GENERATE TREEVIEW = ALL
doxygen linux软件特色它可以从一组文档化的源文件生成一个在线文档浏览器(HTML)和/或离线参考手册($ \ mbox {\ LaTeX} $)。 还支持在RTF(MS-Word),PostScript,超链接PDF,压缩HTML和Unix手册页中生成输出。 文档直接从源中提取,这使得保持文档与源代码一致更容易。
您可以配置doxygen从未记录的源文件中提取代码结构。 这对于在大型源代码中快速找到方法非常有用。 Doxygen还可以通过包括依赖关系图,继承图和协作图来可视化各种元素之间的关系,这些都是自动生成的。
您也可以使用doxygen创建正常的文档(就像我对doxygen用户手册和网站一样)。
下载地址
帮助文档生成器doxygen linux 1.8.13
普通下载通道
请描述一下您遇到的错误,我们将用火箭般的速度修复
软件无法下载
下载后无法使用
与描述不一致
其他问题
网友评论
0条评论
评论需审核后才能显示
doxygen 教程 linux,doxygen linux相关推荐
- 代码文档生成工具Doxygen教程及实例
程序员的很多文档,特别是有代码的文档,绝大部分都是由一款文档生成工具[Doxygen]生成. 什么是Doxygen? Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件.通 ...
- Linux培训教程 Git在linux下的使用
*初始化git仓库,使用gitinit命令 *添加文件到git仓库分两步: 1.使用git add filename ;可分多次使用,添加多个文件到暂存区 2.使用git commit -m & ...
- 虚拟机上php5.6安装教程,手把手安装linux虚拟机教程
一.首先要下载虚拟机的安装包 二.Ubuntu镜像的下载 三.虚拟机硬件配置 1.虚拟机安装完毕之后,界面如下图所示: 点击图中红圈图标,开始创建一个新的虚拟机. 2.在弹出的对话框中选择自定义,然后 ...
- micropython安装ros_ROS2与STM32入门教程-microROS的linux版本
ROS2与STM32入门教程-micro_ros的linux版本 说明: 介绍如何安装使用micro_ros 步骤: 安装ros2版本foxy,查看教程 加载ros2环境 source ~/ros2_ ...
- java查看日志命令_[Java教程]【Linux】linux查看日志文件内容命令tail、cat、tac、head、echo...
[Java教程][Linux]linux查看日志文件内容命令tail.cat.tac.head.echo 0 2017-11-14 12:00:29 linux查看日志文件内容命令tail.cat.t ...
- 宝塔面板 linux工具箱,宝塔面板教程大全–宝塔linux面板专业版数据同步插件使用教程...
宝塔面板教程大全–宝塔linux面板专业版数据同步插件使用教程 宝塔这个同步工具用rsync来改的,有技术能力自己安装rsync也一样的.下面只讲宝塔面板的数据同步,rsync的安装使用关注我的博客, ...
- 备份数据 宝塔linux_宝塔面板教程大全--宝塔linux面板数据备份教程
宝塔面板教程大全--宝塔linux面板数据备份教程 这一部分数据备份包括网站数据备份和数据库的备份.如果不了解数据备份的同学,此章节内容建议认真看一下,做好数据备份是你网站数据安全的最重要的保障! 本 ...
- 使用conda/pip安装pytorch 0.3.1教程(mac/windos/linux)
pytorch v0.3.1发布,添加余弦退火方案来调整学习率以及添加random_split/reduce等函数,其实更新有一段时间了,很多小伙伴安装的时候发现被墙了无法使用,所以我整理了一下方便大 ...
- 服务器安全狗linux安装教程,[linux]安装linux版本64位服务器安全狗的图文教程
[linux]安装linux版本64位服务器安全狗的图文教程 下载服务器安全狗Linux版64位版本 官网的说明 方法1:在官网直接下载软件安装包(.tar.gz 格式:safedog_linux64 ...
- linux版本石器时代,石器时代 架设教程Linux版linux服务器应用 -电脑资料
本文只作学习研究之用,任何人不得非法使用, Linux系统架设石器 概述 首要条件,安装Linux版系统,建议CentOS 4 或者5 工具:SSH vnc for Linux and win xam ...
最新文章
- LeetCode简单题之查找共用字符
- 防止程序重复执行的单元
- SQL点点滴滴_UPDATE小计
- 屏蔽 iOS 系统自动更新
- python中怎么表示整数的点称为整点_智慧职教云课堂APPPython程序设计基础答案公众号...
- 埃斯顿机器人 王杰高_埃斯顿自动化王杰高博士受邀赴韩参加“ROBOT WORLD 2016”等一系列相关活动...
- python中代码块使用缩进来表示对吗_Python 为什么使用缩进来划分代码块?
- php7会不会出问题,升级到PHP7后会话不工作
- 素数筛(快速筛)-爱拉托斯特尼筛法+欧拉筛
- thinkphp3.1 mysql5.6_ThinkPHP3.1新特性之多数据库操作更加完善
- “你打算怎么构建云安全资源池”
- 快速删除excel中的空行
- 计算机网络应用层题库
- DDD | 领域驱动设计 Vs 敏捷 Vs 面向对象
- C语言把分钟数转换成小时和分钟
- 前端HTML网页文档模板介绍以及常用标签
- 解决Identify and stop the process that‘s listening on port 8080 端口问题
- 47个经典java程序编程题
- 内存卡删除的文件如何恢复?三个步骤解决
- 基于java Springboot实现教务管理系统《视频版-建议收藏》
热门文章
- java 不显示imageicon_Java ImageIcon 不能显示问题
- linux服务器进程不存在,查看 Linux 服务器的进程
- ogg 登录mysql报字符集_mysqldump之字符集问题解决
- maven servlet配置_Servlet入门
- js获取/设置任意元素中间内容的兼容方法
- Linux FTP安装问题
- Web框架之Tornado
- python入门:输出1-100之内的所有奇数和偶数
- [PYTHON] 深度解析copy.copy() 与 copy.deepcopy()
- Vue-vue-router.js路由--进级