doxygen(帮助文档生成器) linux

大小:48.9M 类别:
  • 编程其它

官方安全无插件纠错

  • 更新时间2023-11-14
  • 版本v1.9.8
  • 系统Pc
  • 语言英文
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(帮助文档生成器)

    5.0/44.94M

    doxygen是一个程序的文档产生工具,以类似JavaDoc风格描述的文档系统,目前Doxygen可处理的程序语言包含C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。

    查看

猜您喜欢

linux软件合集

在Linux系统中,有许多令人印象深刻的软件可以满足用户的各种需求。无论是为了提高生产力、进行娱乐或是进行开发,这些软件都提供了强大的功能和用户友好的界面。从开源办公套件到多媒体播放器,从文本编辑器到网络安全工具。那么今天小编就为大家整理了一些linux常用软件合集,让您的Linux体验更加完善。无论您是新手还是经验丰富的Linux用户,这些软件都值得一试,有需要的朋友欢迎下载体验。

共有 58 款应用全部>>

类似软件

  • Docker Desktop for Windows官方版

    8.9/499.59M

    一个开源的应用容器引擎

    查看
  • dubbo admin官方版

    9.0/1.43M

    分布式服务框架

    查看
  • Jailer数据文件提取工具

    9.1/38.09M

    Jailer是一款功能十分强大的智能数据提取工具,它可以帮助你从关系数据库中直接导出连续、相关的行数据,然后你可以将这些数据直接在你自己的开发测试环境使用,并且支持DB2、Firebird、Derby等应用,例如你可以在不损害其它数据完整性的情况下删除某一特定数据行从而提高数据库

    查看
  • ApexSQL Generate

    9.1/51.98M

    ApexSQL Generate是一款强大的SQL Server测试数据生成器。功能上软件就为用户们提供了指定的列项和表格生成测试数据,支持预定义生成器、表格映射、生成数据的预览、随机化测试数据、跨数据库数据生成自定义SQL语句等功能,非常适合SQL Server数据库开发人员使

    查看

网友评论

0人参与,0条评论
  • 评论需审核后才能显示

同类排行

  • 和平精英绿洲启元编辑器

    10.0/5.91M

    和平精英绿洲启元编辑器是由腾讯游戏光子工作室发布的开发者工具。绿洲启元是基于《和平精英》创作出的新玩法模式,创作者们可以通过绿洲启元来释放自己的无限创意,将《和平精英》从传统的FPS玩法模式中解放出来,衍生出更加多样化的精彩玩法。

    查看
  • Microsoft.NET Runtime(微软NET运行库)

    9.1/217.88M

    Microsoft.NET Runtime(微软.NET运行时)是Windows操作系统用于.NET构建的应用程序所需的基础类型库组件。小编这次给大家带来的是微软NET 5.0运行时离线版,这次的版本更新非常重视 .NET 的统一性,微软希望 .NET Framework 开发者

    查看
  • SQLmap(自动化SQL注入工具)

    9.1/7.28M

    SQLmap是一个开源免费,且非常知名的自动化的SQL注入工具,其主要功能是扫描,发现并利用给定的URL和SQL注入漏洞,其广泛的功能和选项包括数据库指纹,枚举,数据库提权,访问目标文件系统,并在获取操作权限时执行任意命令。

    查看
  • CiteSpace官方版

    8.9/103.62M

    CiteSpace官方版是一款和Java相关的可视化文献分析软件,它能够显示一个学科或知识域在一定时期发展的趋势与动向,形成若干研究前沿领域的演进历程!并且,citespace能很好的帮助大家从众多的数据中如何找到自己所需要的,从而解决哪些文献是具有开创性和标志性的问题,有

    查看
  • OpenGL ES 2.0库

    9.1/854K

    OpenGL ES 2.0是OpenGL三维图形API的子集,针对手机、PAD和游戏主机等嵌入式设备设计,而小编带来的OpenGL ES 2.0是其2.0版本,这一版本主要针对可编程管线硬件,参照OpenGL 2.0的规范定义的。

    查看
  • Subclipse(Eclipse SVN插件)

    9.1/2.96M

    Eclipse是一个非常优秀的开源IDE,目前支持C/C++、JAVA、JS、PHP等语言的程序编写,Subclipse是一个针对Eclipse打造的框架和插件服务,用于通过插件组件构建开发环境。

    查看
  • Visustin流程图制作软件

    8.7/5.5M

    Visustin官方版是一款非常专业好用,且主要面向软件开发者和文档编写人员所量身设计的自动化流程图程序。其主要功能便在于通过自动代码可视化节省文档工作,将您的源代码逆向设计为流程图、或UML活动图,一键读取if和else语句、循环和跳转,并构建图表等操作。

    查看
  • composer(PHP依赖管理工具)

    9.0/1.18M

    使用PHP进行开发需要许多工具来帮助用户来进行管理代码,这款composer就是一款非常不错的全球知名的PHP依赖管理工具,是许多网页开发用户需要用到的管理工具。软件允许用户申明项目所以来的代码库,然后他就会在你的项目中帮助你安装他们,比如一些框架,像是laravel这一类的PH

    查看
  • small basic官方版

    8.9/6.14M

    small basic官方版是一款微软推出的编程语言的最基本概念,对于初学者来说是最容易入手的编程语言,这款编程语言最早是针对儿童推出的免费编程语言,不想Scratch和Alice,这款工具本质上讲是一个简略版本的BASIC语言,该语言脱胎于传统的BASIC语言,但是却基于微软的

    查看
  • groovy语言

    9.0/48.49M

    groovy是一种基于JVM的开发语言,也是一种功能强大的可选类型和动态语言,具有静态类型和静态编译功能,适用于java品台,旨在通过简洁,熟悉且易于学习的语法提高开发人员的工作效率,该语言还结合了Python、Ruby和Smalltalk的许多强大的特性。

    查看
  • android ndk开发工具(Native Development Kit)

    9.0/628.62M

    android ndk开发工具又叫:ndk、Native Development Kit。是一款专门为安卓系统设计的安卓开发环境。主要作用是为用户开发安卓原生应用起到提供框架的作用。

    查看
  • Cmd Markdown编辑器

    9.1/20.72M

    Cmd Markdown是一款独特而强大的Markdown编辑工具。对于Markdown大家一定不陌生了,但是每种编辑器都有它的优缺点。但是这款工具可以说已经做到了尽善尽美了。

    查看
  • GitKraken官方版(GIT图形化工具)

    8.9/327.4M

    一个专业的GIT图形化工具

    查看
  • wordpress(php网站构建器)

    9.1/34.87M

    wordpress是一款开源博客工具和CMS发布平台,主要用于创建和管理网站和博客,通过它用户们可灵活部署网站,加上其友好的界面和强大的功能扩展性,成为全球最受欢迎的网站构建工具之一!

    查看
  • 白鹭游戏引擎Egret Engine

    9.0/22.04M

    白鹭游戏引擎Egret Engine是一个免费开源的游戏框架,用于构建二维游戏、演示程序和其他图形界面交互应用等等,该引擎采用TypeScript脚本语言开发,当用户开发完成游戏后,你能够轻松的将程序转换为HTML5实现跨平台运行。

    查看