2024年代码文档生成工具Doxygen教程及实例，2024-2024阿里巴巴Golang面试真题解析

最新推荐文章于 2024-05-21 17:31:45 发布

2401_84925152

最新推荐文章于 2024-05-21 17:31:45 发布

阅读量963

点赞数 18

分类专栏：程序员文章标签： go 学习面试

本文链接：https://blog.csdn.net/2401_84925152/article/details/138850678

版权

程序员专栏收录该内容

57 篇文章 0 订阅

订阅专栏

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以添加戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

doxywizard使用步骤

工作目录如下：

.
├── out
└── src
    └── math.h

其中math.h代码如下：

/*! \file math.h */

/*!
    用于求一个角度的sin值，输入是字符串以便同时支持弧度制和角度制表示
    \li 弧度制用pi表示，例如：2pi表示一圈、0.5pi表示直角
    \li 角度制用d结尾，例如：360d表示一圈、90d表示直角
    \li 输入也可以是数值，例如：输入3.14159大约表示180度

    \param a 用弧度制或角度制表示都行，字符串必须用'\0'表示结束
    \param[out] res 是输出参数，用于保存sin运算的结果

    \return 错误码，0表示成功，其它表示失败

    \todo 在xxx的情况下存在BUG，预计下一版本修复
*/
int sin(char *a, double *res);

Doxygen生成的HTML会放到out目录下，生成的HTML如下图所示。

HTML界面

3、保存配置
上面我们配置了一些选项，也成功生成了HTML文档。我们希望下次代码改动后能够继续沿用上次配置，那么我们可以把这些配置保存成Doxyfile文件，如下图所示。

保存Doxyfile配置文件

有了配置文件后我们完全可以通过命令行来生成API文档，假设配置文件名为Doxyfile，那么我们只需要执行doxygen /path/to/Doxyfile即可生成API文档。
通过命令行生成文档有许多好处，其中最主要的好处就是：能够集成到持续集成之类的自动化系统中。

1.什么样的注释会被Doxygen识别？
Doxygen能识别这几种风格的注释：

/**
 * ... text ...
 */

/*!
 * ... text ...
 */

///
/// ... text ...
///

//!
//!... text ...
//!

文件的开头必须有文件注释，否则该文件不会被识别：

/*! \file math.h */

2.注释怎么写
这里建议参考官网例子。https://www.doxygen.nl/manual/doxygen_usage.html

Doxygen主要支持C语言，其它语法跟C差不多的语言（如：C++/C#/PHP/Java）也能够支持，我们称这类语言为「C语系语言」。而哪些跟C语法差异较大的语言叫做「非C语系语言」。
对于大多非C语系语言，Doxygen都是支持的，Doxygen原生支持这些语言：IDL、Java、Javascript、C#、C、C++、D、PHP、Objective-C、Python、Fortran、VHDL。
万一项目需要的语言（例如：Lua）Doxygen官方并不支持，那么只能自行编写「第三方语言扩展」来支持了。
1.Doxygen官方支持的语言见下图，文件名符合FILE_PATTERNS都会被处理。其中包括了.c、.h、.py等等。

如果我们的扩展名并不在FILE_PATTERNS内，那么可以加上去。例如我们项目下的所有.ccc文件，其实是C语言代码（这很奇葩，举个例子而已）。那我们可以编辑Doxyfile配置文件满足这一需求，需要2个步骤。
(1) 在FILE_PATTERNS中添加*.ccc，如下图：

(2) 在EXTENSION_MAPPING中添加映射规则ccc=C，如下图，语法是ext=language，其中language可以取的值有：IDL、Java、Javascript、C#、C、C++、D、PHP、Objective-C、Python、Fortran、VHDL。

2.Doxygen官方不支持的语言
以Lua语言为例，它的代码是长这样的：

-- \file lmath.h
--[[    用于求一个角度的sin值，输入是字符串以便同时支持弧度制和角度制表示    \li 弧度制用pi表示，例如：2pi表示一圈、0.5pi表示直角    \li 角度制用d结尾，例如：360d表示一圈、90d表示直角    \li 输入也可以是数值，例如：输入3.14159大约表示180度
    \param a 字符串类型，表示角度，用弧度制或角度制表示都行
    \return 返回sin运算的结果
    \todo 在xxx的情况下存在BUG，预计下一版本修复--]]function sin(a)    return 1.123end

可以看到Lua的语法既不像C也不像Python。
本文就分享到这里，更详细的使用教程可以查看官方文档：

https://www.doxygen.nl/manual/doxygen_usage.html

转载于：https://mp.weixin.qq.com/s/XfaP6DF5G6lgXRJo8XAV2Q

如果只有一个没有注释的文件文件，一个没有注释的函数

#include <stdio.h>

int main(void) {
    printf("Hello World!\n");
}

最后产生的文档则是啥也没有。

还是一个源文件，文件有注释，函数也有两个，函数也都有注释

/\*\*
 \* @file main.c
 \* @author JonesLee
 \* @email Jones\_Lee3@163.com
 \* @version V4.01
 \* @date 07-DEC-2017
 \* @license GNU General Public License (GPL) 
 \* @brief Universal Synchronous/Asynchronous Receiver/Transmitter 
 \* @detail detail
 \* @attention
 \* This file is part of OST. \n 
 \* This program is free software; you can redistribute it and/or modify \n 
 \* it under the terms of the GNU General Public License version 3 as \n 
 \* published by the Free Software Foundation. \n 
 \* You should have received a copy of the GNU General Public License \n 
 \* along with OST. If not, see <http://www.gnu.org/licenses/>. \n 
 \* Unless required by applicable law or agreed to in writing, software \n
 \* distributed under the License is distributed on an "AS IS" BASIS, \n
 \* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. \n
 \* See the License for the specific language governing permissions and \n 
 \* limitations under the License. \n
 \* \n
 \* @htmlonly 
 \* <span style="font-weight: bold">History</span> 
 \* @endhtmlonly 
 \* Version|Auther|Date|Describe
 \* ------|----|------|-------- 
 \* V3.3|Jones Lee|07-DEC-2017|Create File
 \* <h2><center>&copy;COPYRIGHT 2017 WELLCASA All Rights Reserved.</center></h2>
 \*/  

#include <stdio.h>

/\*\*
 \* @brief hhhhh,this is a test file.
 \* 
 \* @return int 
 \*/
int add(int a, int b) {
    return a+b;
}

int main(void) {
    printf("Hello World!\n");
}

最后生成的文档如下图：

有多个源文件，每个文件有多个函数

在这里插入图片描述

main.c

/\*\*
 \* @file main.c
 \* @author JonesLee
 \* @email Jones\_Lee3@163.com
 \* @version V4.01
 \* @date 07-DEC-2017
 \* @license GNU General Public License (GPL) 
 \* @brief Universal Synchronous/Asynchronous Receiver/Transmitter 
 \* @detail detail
 \* @attention
 \* This file is part of OST. \n 
 \* This program is free software; you can redistribute it and/or modify \n 
 \* it under the terms of the GNU General Public License version 3 as \n 


![img](https://img-blog.csdnimg.cn/img_convert/d6648303b62d48ba71d9669bcf182d25.png)
![img](https://img-blog.csdnimg.cn/img_convert/d442037f13750a6ed2b14be51aa86500.png)
![img](https://img-blog.csdnimg.cn/img_convert/b91727869f4caf834ad39625b7f862b4.png)

**既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上Go语言开发知识点，真正体系化！**

**由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新**

**[如果你需要这些资料，可以戳这里获取](https://bbs.csdn.net/topics/618658159)**

[外链图片转存中...(img-25qI05c4-1715663376134)]
[外链图片转存中...(img-4obahEzO-1715663376134)]

**既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上Go语言开发知识点，真正体系化！**

**由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新**

**[如果你需要这些资料，可以戳这里获取](https://bbs.csdn.net/topics/618658159)**

2401_84925152

关注

18
点赞
踩
20

收藏

觉得还不错? 一键收藏
0
评论
2024年代码文档生成工具Doxygen教程及实例，2024-2024阿里巴巴Golang面试真题解析

doxywizard使用步骤其中math.hDoxygen生成的HTML会放到out目录下，生成的HTML如下图所示。HTML界面上面我们配置了一些选项，也成功生成了HTML文档。我们希望下次代码改动后能够继续沿用上次配置，那么我们可以把这些配置保存成Doxyfile文件，如下图所示。保存Doxyfile配置文件有了配置文件后我们完全可以通过命令行来生成API文档，假设配置文件名为Doxyfile，那么我们只需要执行doxygen /path/to/Doxyfile即可生成API文档。
复制链接

扫一扫