Doxygen基础篇（三）——增加导航窗口
Doxygen基础篇（三）——增加导航窗口
前言：
为了更方便查看，Doxygen生成的HTML文档可以增加导航栏显示。
1 导航栏配置
打开Doxygen向导，选择 Wizard -> Topics -> Output ，勾选 with navigation panel 选项，该选项表示生成带有导航窗口的文档。
重新生成文档，效果如下。
本博客所有文章除特别声明外，均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来源 OnlyCalm's Blog！
相关推荐
2021-08-15
Doxygen基础篇（四）——增加宏定义
Doxygen基础篇（四）——增加宏定义前言： c/c++这样带宏定义的编程语言经常会用到预编译宏，部分代码是由宏控制的可选代码，但要让Doxygen正确处理这些代码可能需要手动添加宏定义。 1 代码被Doxygen忽视 预编译宏中的代码可能被Doxygen忽视，生成的文档中不含有这部分代码的说明。如果一段代码被预编译宏控制为可选代码，预编译宏在其他文件甚至编译器的配置中定义，那么Doxygen不能解析到该宏定义，导致不能生成这段代码的文档说明，解决办法需要手动在Doxygen中添加相关的宏定义。 2 添加宏定义 &emps;打开Doxygen向导，找到关于预定义宏的设置项。 Expert -> Topics -> Preprocessor -> PREDEFINED 。在该项中添加需要的宏设置。 当定义的宏带值时，使用 = 进行赋值，但等号前后不能加空格，否则无法识别。例如： SWITCH=1
2021-07-31
Doxygen基础篇（一）——安装Doxygen
Doxygen基础篇（一）——安装Doxygen前言： Doxygen可以像JavaDoc那样提取代码中的注释生成文档手册，它不仅是一种文档生成工具，更是一种注释的规范，要写出规范的代码掌握Doxygen是必要的。 1 Doxygen简介 Doxygen 是一种开源跨平台的代码文档生成工具。Doxygen可将按照其规定格式编辑的注释信息提取转换生成方便阅读的说明文档，文档格式有LATEX、RTF等，支持C, Objective-C, C#, PHP, Java, Python等语言。 2 安装Doxygen2.1 Windows下安装Doxygen Windows下载官网找到exe文件下载安装，它捆绑了32位和64位版本，根据操作系统自动选择合适的版本安装。里面包含了手册和GUI。 在点击 I accept the agreement 然后点击 Next...
2021-08-01
Doxygen基础篇（二）——配置Doxygen
Doxygen基础篇（二）——配置Doxygen前言： 在Windows上可以方便的通过GUI配置Doxygen，按照配置生成代码帮助手册。 1 配置Wizard1.1 配置Project 打开 Doxygen GUI frontend ，选择 Wizard 标签页下 Project 选项进行该页面的配置，该选项下是关于项目的一些基础设置。 Specify the working directory from which doxygen will run: 为安装的Doxygen的工作目录，路径要选到安装目录下的bin目录； Project name: 该项目的名称； Project synopsis: 该项目的项目简介； Project version or id: 项目版本或id； Project logo: 选择项目的logo图标，文件为图片格式； Source code directory: 工程源代码的目录，需要被提取注释生成文档的代码应该在此目录下； Scan recursively:...
2020-03-10
c代码Doxygen注释规范
c代码Doxygen注释规范前言： 良好得注释风格利于后期维护和团队协作开发，使得代码逻辑清晰，意图明了。Doxygen是一种能自动提取代码内注释生成版主文档的开源软件，它是跨平台的。非开源项目也许并不需要有这样一份帮助文档，但Doxygen的注释规范也不失为一种好的风格，可以推广遵守。 1 Doxygen注释规范模板1.1 文件注释模板123456789/** * @file 文件名（*.h/*.c） * @brief 该模块功能的简介。 * @details 使用该模块有哪些细节注意等。 * @author 创建该文件的人名。 * @data 该文件的创建日期（2020-03-10）。 * @version 文件或模块版本号（V1.0.0）。 * @copyright 版权所属公司。 */ 若某项无相关的说明，中文写 无 ，英文写 None ，此时末尾不加标点，若有相关的说明，则建议正常使用标点符号，包括句末标点。 1.2 函数注释模板1.2.1 完整格式1234567891011121314151617181920/** *...
2025-05-04
Docker基础篇（一）——安装
Docker基础篇（一）——安装前言：阅读这篇文章我能学到什么？ Linux环境下开发，经常会用到Docker，本片文章介绍如何安装Docker。 1 介绍 Docker是一种开源的容器化平台，用于开发、部署和运行应用程序。它通过容器技术将应用程序及其依赖项打包到一个轻量级、可移植的虚拟环境中，从而实现快速部署和跨平台运行。Docker的核心组件是开源免费的。 Docker的核心概念是容器、镜像、仓库，详细可查阅 [Docker官网](https://docs.docker.com/ “Docker官网”) 。 镜像: 通过容器的静态模板，其包含了运行所需的所有文件和配置。 容器: Docker是轻量级的虚拟化单元，包含应用程序及其运行环境，容器共享主机的操作系统内核，比虚拟机更加高校，运行更快。 仓库: 集中化存储和分发镜像的平台，分为公共仓库（如Docker...
2025-05-04
Docker基础篇（三）——容器的操作
Docker基础篇（三）——容器的操作前言：阅读这篇文章我能学到什么？ 这篇介绍容器有关的操作。 1 创建容器1.1 创建但不运行 根据指定镜像创建容器，但不运行该容器。 指定镜像名称创建容器。-it 表示该容器启用交互式终端。 1docker create -it --name container_name image_name:tag 指定镜像名称创建容器。 1docker create -it --name container_name image_id 1.2 创建并运行 根据指定镜像创建容器，且运行该新容器。 指定镜像名称创建容器。 -it 表示该容器启用交互式终端。 1docker run -it --name container_name image_name:tag /bin/bash 在容器终端中执行 exit...
评论
ValineGitalk
