Doxygen (3): 注释规范

已于 2022-08-29 19:14:43 修改
阅读量288 收藏 1
点赞数
分类专栏： Doxygen 文章标签： c++
于 2022-08-29 17:33:17 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_37896521/article/details/126589098
版权

文章目录

0. 前言

  专题目录如下:

1. 类的注释

/**
 * @class		TMesh2D
 * @brief		T-mesh
 * @details		2D 指的是参变量的个数是2个.相对应的 TMesh3D对应
 *			 T-Lattice.
 * @note		本代码中规定 T-mesh 同时定义在 (I) & (P) 中.
 * @todo		本代码还未接入 CtrlMesh-TMesh 的接口,之后需要接入.
**/

  输出页面:
？？？？？？？？？

2. 函数注释

/**
 * @brief		函数简介
 * @details		详细说明
 *
 * @param		param1	参数说明1
 * @param		param2	参数说明2
 * 
 * @return		返回说明
 *				| bool  | return	|
 *				|-------|-----------|
 *				| true  | 仅说明		|
 *				| false | 仅说明		|
 * @retval		返回值说明
 * @see			www.baidu.com
 * 
 * @note		注解
 * @attention	注意
 * @warning		警告
 * @exception	异常
 * @todo		会链接到 TODO 列表
 * 
 * @par Example: 
 * @code
 *	TMesh2D tm;
 *	tm.Function(1, 1.0);
 * @endcode
**/

  输出页面:
在这里插入图片描述

Amor灬Niss
关注
专栏目录
Doxygen代码注释规范.docx
07-15
Doxygen 代码注释规范 Doxygen 是一种开源跨平台的，以类似 JavaDoc 风格描述的文档系统，完全支持 C、C++、Java、Objective-C 和 IDL 语言，部分支持 PHP、C#。Doxygen 可以从一套归档源文件开始，生成 HTML 格式...
Doxygen代码注释规范
02-06
"Doxygen代码注释规范" Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。Doxygen可以从一套归档源文件开始，生成HTML格式的在线类...
代码注释规范之doxygen
11-19
总之，Doxygen提供了一套完整的程序注释文档化解决方案，它能够自动识别遵循特定注释规范的代码段，并生成多种格式的文档。为了充分发挥Doxygen的作用，开发者需要了解其配置方法以及如何利用Graphviz和...
Doxygen代码注释标准.7z
10-21
这个压缩包“Doxygen代码注释标准.7z”包含了最新版本的Doxygen安装程序、Graphviz图形生成工具以及帮助文档生成所需的相关软件，旨在帮助开发者遵循Doxygen注释规范，生成清晰、详尽的项目文档。 首先，让我们深入...
doxygen 注释生成工具
09-06
**doxygen注释生成工具详解** `doxygen`是一款广泛使用的开源文档生成工具，它能够自动从源代码中提取信息，生成结构化的、易于阅读的API文档。这款工具支持多种编程语言，包括C++, C, Java, Python, Objective-C, ...
【C++刷题】力扣-#121-买卖股票的最佳时机
会写代码的饭桶
10-16 322
给定一个数组 prices，其中 prices[i] 表示第 i 天的股票价格。假设你可以在第 i 天买入并在第 j 天卖出股票（i ≤ j），设计一个算法来计算你所能获取的最大利润。注意你只能持有一股股票，并且你不能同时参与多笔交易（即在再次买入前必须卖出股票）。
如何用c++模拟创建用户（只得创建一个用户）
2301_78863827的博客
10-14 777
模拟系列，希望大家能多提意见
VScode中CMake无高亮（就是没有补全的提示）
Moapsw033的博客
10-15 273
原因就是：本地没有配置环境变量，解决方法是下一个cmake然后直接配置环境变量。在我学的过程中我发现我的CMake是这样的，如下图。这非常的难受，所以疯狂的找，最后是CMake报错有。如何配置环境变量就直接上网找就好了，很简单的，加油。但在教学视频里是这样的（如下图）
C++中的vector介绍（常用函数）
zxybf_的博客
10-15 744
vector的文档介绍vector是序列容器，表示可以改变大小的数组。(constructor)构造函数声明接口说明vector()（重点）无参构造构造并初始化n个val（重点）拷贝构造使用迭代器进行初始化构造int main()//无参的构造//n个val的构造//拷贝构造//迭代器区间构造return 0;
东方博宜OJ P1000-P1100题 C++ 和 Python 题解代码汇总
10-18 230
【代码】东方博宜OJ P1000-P1100题 C++ 和 Python 题解代码汇总。
C++中的CRTP
最新发布
moter的专栏
10-18 568
我们知道，要定义派生类肯定需要知道基类的类型，而在使用类模板来实例化一个模板类时又得需要知道模板的实参类型，在这里实例化基类时的实参类型又是派生类的类型。CRTP基类是类模板，基类实例化之后，和派生类是一一对应的，即一个基类只能派生一个子类，而模板参数化this指针的实现方式是基类只有一个，而且是非模板类，它的派生类可以有多个，但是每定义一个派生类，在该基类中都会使用派生类类型实例化出一个对应的interface()函数，也就是在基类中会有多个interface()成员函数和它的派生类一一对应。
【C语言】指针与函数：传值与传址
我的我的博客
10-17 518
函数在使用的时候，给到的形式参数属于局部变量，仅在函数体内部有效。 1. 传值，对于两个值的交换，不影响函数调用之前的数值。这个就是传值，传递的是实参。 2. 传址，如果想通过函数来改变原本两个变量的值，那么需要传递地址。 3. 另外一种方式就是定义**全局变量**，参数不进行传递。可以直接实现在自定义函数体内，改变main函数中、或者其他函数中的值。
南沙C++信奥赛陈老师解一本通题 1943：【08NOIP普及组】排座椅
vx_cyf1333888的博客
10-16 253
第一行包含KK个整数，a1,a2……bL，表示第b1b1列和b1+1b1+1列之间，第b2b2列和b2+1b2+1列之间、。第ii行的44个证书Xi，Yi，Pi，OiXi，Yi，Pi，Oi,表示坐在位置（Xi，YiXi，Yi）与（Pi，OiPi，Oi）的两个同学会交头接耳（输入保证他们前后相邻或者左右相邻）。第一行，有55个用空格隔开的证书，分别是M,N,K,L,D（2≤N,M≤1000,0≤K<M,0≤L<N,D≤2000）M,N,K,L,D（2≤N,M≤1000,0≤K<M,0≤L<N,D≤2000）
C++：继承
WG_17的博客
10-13 876
下⾯我们看到Person是基类，也称作⽗类。Student是派⽣类，也称作⼦类。(因为翻译的原因，所以 既叫基类/派⽣类，也叫⽗类/⼦类)
C++ vector迭代器失效
10-15 234
参考博文： https://blog.csdn.net/m0_61982936/article/details/132548446此前一直没有注意到vector的失效情景，但仔细思考下发现有很多失效的坑。首先需要明确的是vector的扩容：有两个参数size:指的是vector当前元素多少capacity:指的是vector的容量，也即max_size。如果size >= capacity时就会发生扩容，拷贝元素并且释放旧空间。通常采用1.5倍扩容或者2倍扩容。
快手C++二面-面经总结
MatsumotoChrikk
10-18 396
cat words.txt：读取文件 words.txt 的内容。tr -s ' ' '\n'：将空格替换为换行符，即将每个单词分隔到一行。sort：对单词进行排序。uniq -c：统计每个单词出现的次数，并在前面加上频率。sort -nr：按照频率降序排序。awk '{print $2, $1}'：使用 awk 输出单词和频率，其中 2是单词，1 是频率。
[原创]在Delphi高效率的使用函数指针, TProc和TFunc类型.
其实我不是代码教父,我只是猪头三
10-18 393
由于最近又开始做一些代码转换, C++转换到Delphi, 这里涉及到函数指针的利用. 那么在最新的Delphi中, 针对函数指针, 提供了使用更方便的: TProc和TFunc类型.
learn C++ NO.23——map、set的模拟实现
sinzz的博客
10-13 1014
本篇文章以STL库为模板，模拟实现了map和set。实现了map和set的跌打器部分以及map的operator[]。通过封装一份简易版本的map和set，学习库的设计者的设计思路，以到达更好的理解map和set。
各种语言的序列化与反序列化(C/C++ c# Python Javascript Java)
weixin_42462436的博客
10-18 532
C++中手动实现序列化常用文件流，Boost 提供了更高级的序列化库。C#提供了丰富的序列化方法，包括 JSON、XML 和二进制序列化。Python中常用json模块和pickle模块进行序列化与反序列化。JavaScript主要通过和JSON.parse实现 JSON 序列化与反序列化。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值