5.4 C++风格的注释

PyTorch、Torchvision、Torchaudio历史版本whl文件下载地址、版本对应关系与离线安装全攻略 本文详细解析了PyTorch、Torchvision和Torchaudio历史版本whl文件的下载地址、版本对应关系及离线安装全攻略。针对无网络环境下的安装挑战,提供了官方whl文件获取路径、版本匹配技巧和完整安装流程,帮助开发者高效解决兼容性问题,确保深度学习环境的稳定部署。 阅读详情

5.4      C++风格的注释

5.4.1    概述

C++的注释风格主要使用下面这种样式:即在注释块开始使用三个反斜杠‘/’
其他地方其实与JavaDoc的风格类似,只是C++风格不用 “*” 罢了。

5.4.2       简述与详述

C++风格的简述与详述方式与javaDoc类似。
一般注释的描述由简述开始,经过特殊分隔方式后,后面紧跟详述的内容,C++风格可以使用的分隔方法有以下两种:
(1)使用 \brief 参数标识,空行作为简述和详述的间隔标识
  1. ///     \brief   Brief description.
  2. ///     description continued.
  3. ///
  4. ///     Detailed description starts here.
  5. ///
(2) 使用以空行 enum enumEditType
{
enumEditTypeInt=0x1, //只能输入数字。
enumEditTypeChar=0x2, //只能输入字符。
enumEditTypeNormal=0x3, //正常编辑框,可以输入任意字符。
};

typedef struct tagEDITxsl
{
UINT  nMinChar;
UINT nMaxChar;
enumEditType m_edit_type;
std::wstring m_disable_char;
};

(或者小数点加空格)作为简述与详述的分割
  1. ///    Brief description
  2. ///    description continued.
  3. ///   
  4. ///    Detailed description starts here.
以小数点加空格作为分隔如下:
  1. ///          Brief description
  2. ///          description continued . (注意:这里有一个小数点,加上一个空格)
  3. ///          Detailed description starts here.
  4. ///

5.4.3    注释风格约定

1. 一个代码块(类、函数、结构等)的概述采用单行的”///”加一个空格开头的注释,并写在该代码块声明的前面;
2. 一个代码块的详述采用至少两行的”///”加一个空格开头的注释,若不足两行第二行的开头也要写出来,并且放在代码块定义的前面;如果某代码没有声明只有定义或者相反,则在定义或者声明前面写上单行的概述+一个空行+多行的详述;
3. 枚举值列表的各项、结构域的各项等采用在本行最后添加”///<”加一个空格开头的注释;
4. 对变量的定义采用在变量上面加单行”///”加一个空格开头的注释(相当于是给改变量一个概述);
5. 函数的参数用”/// @param”+一个空格开头的行描述在函数的详述里面;
6. 函数的返回值用”/// @return”+一个空格开头的行描述在函数的详述里面;
7. 函数之间的参考用”/// @see”+一个空格开头的行描述在函数的详述里面;
8. 文件头的版权以及文件描述的注释参见例代码。

5.4.4       文件头注释示例

  1. //////////////////////////////////////////////////////////////////////////
  2. ///     COPYRIGHT NOTICE
  3. ///     Copyright (c) 2009, 华中科技大学      (版权声明)
  4. ///     All rights reserved.
  5. ///
  6. /// @file     (本文件的文件名eg:Test.h)
  7. /// @brief (本文件实现的功能的简述)
  8. ///
  9. ///(本文件实现的功能的详述)
  10. ///
  11. /// @version 1.1      (版本声明)
  12. /// @author             (作者,eg:卢俊)
  13. /// @date                 (文件创建日期,eg:2009年7月15日)
  14. ///
  15. ///
  16. ///     修订说明:最初版本
  17. //////////////////////////////////////////////////////////////////////////

5.4.5       类定义注释示例

  1. ///     本类的功能:打印错误信息
  2. ///
  3. ///     本类是一个单件
  4. ///     在程序中需要进行错误信息打印的地方
  5. class CPrintError
  6. {
  7.            ……
  8. }

5.4.6       类成员变量定义示例

(1)在成员变量上面加注释的格式
  1. /// 成员变量描述
  2. int   m_Var;
(2)在成员变量后面加注释的格式
  1. int   m_color;     /// 颜色变量   

5.4.7       成员函数的注释示例

  1. /// 下面是一个含有两个参数的函数的注释说明(简述)
  2. ///  
  3. ///      这里写该函数的详述信息  
  4. ///      @param a 被测试的变量(param描述参数)  
  5. ///      @param s 指向描述测试信息的字符串  
  6. ///      @return     测试结果 (return描述返回值)
  7. ///      @see     Test()     (本函数参考其它的相关的函数,这里作一个链接)
  8. ///      @note     (note描述需要注意的问题)  
  9. int testMe(int a,const char *s);  

5.4.8       枚举变量的注释示例

  1. ///     颜色的枚举定义
  2. ///
  3. ///     该枚举定义了系统中需要用到的颜色\n
  4. ///     可以使用该枚举作为系统中颜色的标识
  5. enum TEnum
  6. {
  7.      RED,            ///< 枚举,标识红色     
  8.      BLUE,           ///< 枚举,标志蓝色     
  9.      YELLOW          ///< 枚举,标志黄色.     
  10. }enumVar;     

5.5     需要注意的问题

(1)Doxygen会忽略你在注释中加入的多余的换行,如果你希望保留两行注释之间的空行,那么,在该行加入 \n

6      Doxygen使用的常见问题小结

6.1     中文问题:中文注释在文档中是乱码

解决:在expert中的INPUT选项页的INPUT_ENCODEING中填入“GB2312”,这样基于GB的文本编辑器生成的代码就可以正常使用了。

6.2    图形问题:无法绘制类图协作图等图形。

解决:首先确保安装了graphviz for win,注意不是wingraphviz,后者是一个graphviz的com封装,但是doxygen并不是基于它开发的,所以装了也没用。然后在expert的DOT_PATH中填入graphviz的安装路径。接着在wizard的diagram中选择需要生成的图形类别就可以了。
如果出现无法包含.map文件的错误,可以将工作目录设置成html,并将html中所有文件都清除再试。这个问题的原因还不太确定。

6.3    输出chm的问题:如何输出.chm文件

配置时注意expert中的HTML页:选中“GENERATE_HTMLHELP”,然后在CHM_FILE中填上想要的chm文件名。
HHC_LOCATION中输入hhc.exe文件的路径。hhc.exe可以通过安装HTML Help Workshop获得。
或者使用HTML Help Workshop来编译Doxygen生成的html文件夹中的.hhp文件,编译完成后即可在该html文件夹中找到对应的chm文件

6.4     Doxygen无法为DLL中定义的类 导出文档

例如:
class __declspec(dllexport) CClassName:public CObject
{
}
目前发现Doxygen无法识别出DLL中定义的类。

蓝牙模块HM-10手册 蓝牙模块HM-10手册,该手册对蓝牙模块HM-10进行了详细的介绍和使用方法以及一些AT指令。 立即下载

相关推荐

Code Ocean 上传代码 手把手教程

对于一些学术期刊,录用前会让把代码上传到Code Ocean上,但上传过程可能会遇到一些问题,小编分享一下自己的上传经验。他们会进行验证,验证通过,将自动发布。点此运行即可,但是运行比较慢。

u014071947的博客 1万+

C++ 注释风格建议

有个笑话,一位从不写注释的程序员在编写一段复杂的代码时,骄傲地认为这段代码只有自己和上帝知道它是干嘛的,等过了一段时间再回顾时,发现没有注释,感叹到这段代码现在只有上帝知道它是干嘛的。可见,注释是项目中不可或缺的部分,不仅是为了帮助团队其它人员快速理解代码,也是帮助自己快速恢复对代码功能的了解。随意,我们对注释不过要与吝啬,该书写时就书写。 虽然注释书写起来有点麻烦,但是为了提供程序本身额外的信...

Doublelv 的博客专栏。 2万+

Jupyter Lab 无法启动 Kernel 问题排查与解决总结

使用 curl,telnet,或 Python websocket-client 库可以本地模拟 WebSocket 握手行为,帮助分析服务端响应状态。避免使用 http:// + ws:// 组合方式部署 Jupyter Lab,特别是在远程或跨域访问场景。建议统一采用 https:// + wss:// 方式部署,确保浏览器信任并兼容。确认 WebSocket 已升级为 wss://,内核可正常启动。但在远程访问时,浏览器出于安全策略,默认拒绝 ws:// 协议。

weixin_43866043的博客 1861

C++标准注释原则 - 基于doxygen的C++注释

C++标准注释原则 - 基于doxygen的C++注释 https://blog.csdn.net/czyt1988/article/details/8901191   标注总述 下载国外的源代码,往往能看到附带的说明文档,文档都有详细的说明,大部分文档都可以通过doxygen这个跨平台软件生成,doxygen并不能随便读取你的C++的注释,必须按照一定的规则才能生成,所以在编写代码时,...

hunter 3306

Intel SGX Explained

计算机中最主要的资源是CPU和内存,由操作系统和虚拟管理系统等系统软件来管理这些资源。

hanqdi_的博客 3457

SAP 屏幕增强:客户商主数据屏幕增强(KNA1、KNB1、KNVV)

本文介绍了SAP系统中针对客户主数据(KNA1、KNB1、KNVV)进行屏幕增强的具体实现方法。主要内容包括:1)在SPRO配置中创建新条目;2)通过SE80创建函数组和程序(LZKNA1TOP等);3)设置子屏幕9001并添加自定义结构字段;4)利用BADI(CUSTOMER_ADD_DATA等)实现数据交互逻辑。文章分别详细说明了针对客户主数据的一般数据(KNA1)、公司代码数据(KNB1)和销售数据(KNVV)三类不同数据的增强配置步骤,包括函数模块创建、屏幕设置和BADI方法调用等关键技术点。

SAP ABAP开发技能记录分享 1622

C++学习笔记----2、使用C++进行优雅编程(三)----注释风格

每个组织或者说每家公司都有自己的注释风格,没有规矩不成方圆,在编程领域,这条规则依然成立。对于注释,也有各自的要求,在编程规范中都有规定。有时候,这种规定比较松,比如说要写多少注释,以及用什么样的风格都由程序员自己来决定,下面我们就来看一看代码注释的几种方式。

weixin_71738303的博客 1650

全国区块链职业技能大赛国赛考题前端功能开发

全国区块链职业技能大赛国赛考题区块链应用前端功能开发

本郡主是喵 1335

C++ 注释风格

注释风格 注释风格可以根据自己的个人习惯来定,但关键是要统一,为了制定出统一的注释风格所以采用Doxygen注释风格。 使用Doxygen软件可以很方便的生成函数描述文档。 DoxyGen常用命令 命令 生成字段名 说明 @file 文件名 @autho...

AI.PLAY 1455

INFFUS 2025 | DDBFusion:基于双重分解和贝塞尔曲线的统一图像分解与融合框架

现有的图像融合算法大多集中于网络架构和损失函数的设计,采用统一的特征提取策略,却忽略了冗余信息和有效信息的划分。然而,对于互补信息而言,统一的特征提取器可能并不适用。因此,本文提出了一种基于贝塞尔曲线图像增强和分层分解的统一图像融合算法,并构建了一个自监督学习任务来学习有意义的信息。其中,贝塞尔曲线旨在模拟不同的图像特征,并构建特殊的自监督学习样本,因此作者的方法不需要特定任务的数据,并且可以在公共自然图像数据集上轻松进行训练。同时,作者的双重分解自监督训练方法可以为模型赋予冗余信息过滤能力。

小白学视觉 308

基于深度学习的涂胶缺陷类型检测:数据集处理与YOLOv8模型实现

本文提出了一种基于YOLOv8深度学习的涂胶缺陷检测系统,针对断胶、溢胶、缺胶、气泡及胶条宽度异常等常见缺陷类型,实现了从数据采集到模型部署的完整解决方案。系统采用工业相机采集涂胶图像,通过多形态数据增强策略解决样本稀缺问题,利用YOLOv8框架实现高效检测。相比传统人工目检和规则式机器视觉方法,该系统在检测精度(mAP达97.5%)和实时性(单图检测耗时0.038秒)方面表现优异,可满足智能制造场景下的涂胶质量检测需求。

huanghm88的专栏 278

c语言-注释转换

用c语言实现一个简单的功能-注释转换 首先要了解两种简单的注释形式: c风格注释:/* */ c++风格注释:// 效果如下图所示: 用几张图来说明思路: 首先是两个文件的引入: 各种状态间的转换: 对获取字符的各种可能性判断: 实现代码如下:#include <stdio.h> #include <stdlib.h> #include "convert.h" #pragma war

mxrrr_sunshine的博客 374

书旗app字符串加密分析

本文案例是对书旗app搜索接口的请求密文进行分析和逆向。

李玺 3159

单链表分段逆转

题目:给定一个带头结点的单链表和一个整数K,要求你将链表中的每K个结点做一次逆转。例如给定单链表 1→2→3→4→5→6 和 K=3,你需要将链表改造成 3→2→1→6→5→4;如果 K=4,则应该得到 4→3→2→1→5→6。 输入样例: 6 1 2 3 4 5 6 4 输出样例: 4 3 2 1 5 6 我自己写了一份代码,并没有按照题目固定的代码风格,注释和测试数据还是挺详细的,话不...

qq_38346997的博客 1564

汉书HE8,好用的汇编代码编写工具

汉书HE8,好用的汇编代码编写工具早期编写汇编代码所用功能强大

Data-Structures-and-Algorithm-Analysis-in-Java.pdf

作者: Weiss, Mark A. 出版社: Addison Wesley Data Structures and Algorithm Analysis in Java is an “advanced algorithms” book that fits between traditional CS2 and Algorithms Analysis courses. In the old ACM Curriculum Guidelines, this course was known as CS7. This text is for readers who want to learn good programming and algorithm analysis skills simultaneously so that they can develop such programs with the maximum amo...

PHP填坑——注释

PHP填坑——注释 测试环境 PHP version 5.3.29/5.6.29/7.1.0 Apache 2.4.25 PHP中的注释 PHP 支持 C,C++ 和 Unix Shell 风格(Perl 风格)的注释; C 风格的注释在碰到第一个 */ 时结束,要确保不要嵌套 C 风格的注释; // … ?> 或者 # … ?> 之后的 HTML 代码将被显示出来,这是因为?> 跳

web开发小学生的专栏 545

jdk-8u144-linux-x64.tar.gz.

该资源为搭建Linux系统Java环境用,资源的后缀为tar.gz格式的压缩包

代码注释你写对了吗? Doxygen 风格注释,一目了然!

本文围绕 C/C++ 注释规范,介绍了 Doxygen 风格注释。先说明其是标准化格式,可生成结构化文档,支持多种语言,核心是特定标签。接着详细列出文档结构、函数方法等八类标签及使用提示。然后阐述使用方法,包括文件头部、类、函数等多种场景的注释要点与示例,还提及注释风格约定、禁忌及 C++ 特殊注意事项,最后提到相关工具链支持。

memoryfurong的博客 3714

老版QQ原生表情gif动态

这是老版的QQ表情,不过全是动态的的,Windows照片查看器是不会动的,可以右击用浏览器打开查看,再说一遍是老版的,只是分享给宁愿用老版也要动态的人。

C注释风格转化为C++风格注释

C转C++可能遇到的问题: //1.一般情况 /* int i = 0; */ // 2.换行问题 /* int i = 0; */ int j = 0; /* int i = 0; */ int j = 0; // 3.匹配问题 /*int i = 0;/*xxxxx*/ // 4.多行注释问题

Sunnylunch-blog 1552

C++风格的注释

5.4      C++风格的注释 5.4.1    概述 C++的注释风格主要使用下面这种样式:即在注释块开始使用三个反斜杠‘/’ 其他地方其实与JavaDoc的风格类似,只是C++风格不用 “*” 罢了。 5.4.2       简述与详述 C++风格的简述与详述方式与javaDoc类似。 一般注释的描述由简述开始,经过特殊分隔方式后,后面紧跟详述的内容,C++风格可以使用的分隔方

hanghangde的博客 3910

5.3C++注释——《跟老吕学C++》

在C++编程中,注释扮演着至关重要的角色。编写清晰、准确且简洁的注释,并遵循统一的代码风格和注释规范,可以显著提高代码的可读性和可维护性,从而使代码更易于被他人理解和使用。此外,我们也应重视注释的及时更新和维护,确保其始终与代码内容保持一致。值得注意的是,我们应尽量避免依赖注释来处理错误或异常情况,而应采用更为恰当和有效的错误处理机制来解决问题。注释是程序员在代码开发过程中添加的文本说明,它们不会影响程序的实际逻辑,但可以在其中编写与代码相关的有意义的内容。

Python老吕的博客 1514

VScode 编写 C++ 程序:Doxygen 风格注释全指南(语法、插件、实战与文档生成)

在 VS Code 中编写 C++ 程序时,Doxygen 风格注释是一种标准化的代码注释规范,旨在通过结构化的语法生成专业文档(如 HTML、PDF),同时提升代码可读性。其核心价值在于:机器可解析(用于自动生成文档)、人类易理解(统一注释逻辑)。

weixin_41413777的博客 1785

Google C++ 开源风格指南

Google 在 C++ 编程中的代码风格规范、命名约定、注释要求和格式规定,提升代码的可读性、可维护性和规范性。

有耐心做好简单事情,坚持写blog 4205

Doxygen风格的C++注释模板

2020年7月31日 周五 天气晴 【不悲叹过去,不荒废现在,不惧怕未来】 规范化的注释是十分重要的, 基于Doxygen的C/C++注释原则 标注总述 1.文件头标注 2. 命名空间标注 3. 类、结构、枚举标注 4. 函数注释原则 5. 变量注释 6. 模块标注 7. 分组标注 总述 华丽的分隔线 //--------------------------------------------------------------------------- // Platform Defines //-

m0_37433111的博客 2374

【C++ 注释与编码风格】单行注释、多行注释、代码规范

文章摘要: 本文详细讲解了C++注释的作用与使用方法。注释是用于解释代码意图的文字说明,编译器会完全忽略。C++支持两种注释:单行注释(//)和多行注释(/* */)。注释不会影响程序运行性能,仅在源代码中存在。文章还强调了编码规范的重要性,包括命名规则(如snake_case变量名、PascalCase类名)、缩进风格(建议2/4空格)和注释实践(文件头说明、函数注释等)。最后通过一个代码改造练习,演示如何将混乱代码重构为符合规范的易读形式,体现了"代码是写给人看的"这一核心理念。

qq_39078783的博客 422

C++ 风格指南

C++ 风格指南

zhaominyong的专栏 1045

005-C++ 注释

在 C++ 中,注释是程序的一部分,用于向代码添加说明、解释功能或标记重要信息。注释不会被编译器执行,它们仅供开发者阅读。和。单行注释使用//开头,注释从//开始到该行末尾的所有内容。

小宝哥Code的专栏 1941

C++注释风格

每个文件都应该开始于一个注释块,描述文件的目的、作者、创建日期和版权信息。

強雲的博客 617
上一篇: C++各大有名库的介绍
下一篇: Doxygen注释的风格
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明:

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

余额充值