做的网站百度搜索不出来的,公司治理与企业文化建设,外贸网站运营推广,wordpress download 插件此前写过一篇编写Doxygen格式的注释以用于生成文档,点击以查阅, Doxygen常用语法与字段记录,但是当时用的windows桌面版的doxygen,最近使用ubuntu编写代码想直接使用doxygen生成,故写下此博客 Doxygen
Doxygen是一个用于生成软件文档的工具#xff0c;它可以从代码中提取注释… 此前写过一篇编写Doxygen格式的注释以用于生成文档,点击以查阅, Doxygen常用语法与字段记录,但是当时用的windows桌面版的doxygen,最近使用ubuntu编写代码想直接使用doxygen生成,故写下此博客 Doxygen
Doxygen是一个用于生成软件文档的工具它可以从代码中提取注释并根据这些注释自动生成文档。这些注释可以是特殊格式的注释比如C、C、Java等语言中的特定格式也可以是Markdown格式的注释。 以下是一些Doxygen的主要特点和用途
自动生成文档Doxygen可以从源代码中提取注释并生成各种格式的文档包括HTML、PDF、LaTeX等。这样可以轻松地为你的项目生成专业的文档。支持多种编程语言Doxygen支持多种编程语言包括C、C、Java、Python等主流编程语言。你可以在不同的项目中使用Doxygen来生成文档。丰富的文档格式Doxygen支持多种文档格式包括类图、调用图、文件列表等。它还支持跳转到定义、引用和继承等功能使生成的文档更加详细和易于导航。可定制性强Doxygen提供了丰富的配置选项可以根据你的需求定制文档的样式和内容。你可以通过配置文件或命令行选项来控制生成的文档。支持多种输出格式Doxygen可以生成多种格式的输出文档包括HTML、PDF、LaTeX等。这使得你可以选择最适合你项目的文档格式。我们在接下来的课程当中主要使用它来了解第三方库的使用。
Doxygen安装
在 Ubuntu 系统中执行下面命令安装 doxygen 和 graphviz 软件包。
sudo apt install graphviz # 用于生成代码关系图
sudo apt install doxygen使用示例
进入工程目录执行下面命令生成配置文件
doxygen -g Doxygen.config修改配置文件vim Doxygen.config,找到如下字段修改为YES 对于美观有要求可以自行查阅相关资料,修改一些字段 EXTRACT_ALL YES
HAVE_DOT YES
UML_LOOK YES
RECURSIVE YES根据代码生成文档
doxygen Doxygen.config生成效果展示
