doxygen教程-2-下载和运行

下载 doxygen

要下载最正规的程序, 当然要去官网啦. 如图所示, 进入 doxygen 官网的下载页面, 找到 “A binary distribution for Windows”, 列出的就是 Windows 下可用的程序的. 由于公司的电脑会拦截安装程序运行, 所以我选择下载免安装的版本, 即图中的 “64-bit version”.

如果懒得进官网找, 我把下载链接复制过来了: https://www.doxygen.nl/files/doxygen-1.9.2.windows.x64.bin.zip, 可以直接点击这个链接下载.

解压运行 doxygen

解压压缩包

我下载得到的是一个压缩文件 doxygen-1.9.2.windows.x64.bin.zip, 解压后得到的文件如下图所示:

其中 doxygen.exe 就是我们要使用的程序了. 可以看到, 压缩包里没有图形化界面程序 doxywizard.

将解压后的目录加入 PATH 环境变量

由于没有图形前端, 我们需要以命令行的形式运行 doxygen.exe, 为此我们首先要把doxygen.exe 所在目录, 也就是解压后的目录加入环境变量PATH.

在我的电脑上, 解压后的目录是 C:\Users\Stone\Downloads\doxygen-1.9.2.windows.x64.bin.

在 Windows 上, 将一个路径加入环境变量 PATH 有两种方法. 一种是临时的, 在 cmd 窗口输入

path = %path%; <dir_to_add>

其中 <dir_to_add> 要替换成待添加的目录, 例如

path = %path%;C:\Users\Stone\Downloads\doxygen-1.9.2.windows.x64.bin

就将新目录添加到 PATH 变量的末尾了, 如图所示:

由于这种方法是临时的, 所以在退出 cmd 窗口后会失效, 适合只用一次, 不想修改系统设置的情况.

如果想要长期使用, 每次都这样操作就很麻烦, 此时就可以采用第二种添加环境变量的方法. 打开"我的电脑", 进入"系统"控制面板, 然后在左侧点击"高级系统设置", 弹出"系统属性"窗口. 点击"高级"-“环境变量”, 在"用户变量"处选择 Path 变量, 最后点击"新建", 将要添加的目录复制进去即可. 以上只是简述, 如果需要更详细的说明, 可以百度"windows 添加环境变量".

什么是环境变量 PATH?

在命令行窗口(终端)中, 如 Windows 下的 cmd, 和 Linux 下的 shell, 可以执行脚本代码. 实际上我们在终端输入的每一条指令, 都是一句脚本代码. 而代码的存在自然离不开变量. 终端中存在一些特殊的变量, 在终端启动时就已存在, 其取值与运行环境有关, 故称为"环境变量". PATH (Windows 下不区分大小写) 就是这样一个环境变量, 其中存储着一系列目录. 在终端里输入一条命令来运行程序时, 终端首先在工作目录下查找这个程序, 如果找不到, 就会在 PATH 存储的路径中接着找. 所以我们将解压后的目录加入 PATH, 当我们在终端输入命令 doxygen 时, 终端就可以在 PATH 给出的路径中找到 doxygen.exe, 进而运行该程序. 显然, 如果doxygen.exe 的位置发生改动, 就得重新修改变量 PATH 了.

环境变量分为"用户变量"和"系统变量", 通常建议只操作"用户变量".

第一次运行 doxygen

设置了环境变量之后, 就可以尝试运行了. 在终端输入

doxygen

如果环境变量 PATH 设置正确的话, 终端应该会给出如下输出:

这表示我们已经成功运行了 doxygen. 而如果终端的提示是`‘doxygen’ 不是内部或外部命令，也不是可运行的程序

这表示我们已经成功运行了 doxygen. 而如果终端的提示是'doxygen' 不是内部或外部命令，也不是可运行的程序 或批处理文件。, 则说明环境 PATH 设置有误, 需要检查上一步.