0

0

C++中的注释//和/* ... /应该如何规范使用

P粉602998670

P粉602998670

发布时间:2025-09-04 08:05:01

|

659人浏览过

|

来源于php中文网

原创

单行注释//用于简短说明,推荐置于代码上方;块注释/.../用于多行描述或函数说明,不可嵌套。

c++中的注释//和/* ... /应该如何规范使用

在C++中,///* ... */ 都是合法的注释方式,但它们适用的场景和规范使用方式有所不同。合理使用能提升代码可读性和维护性。

单行注释 // 的使用规范

适用于对单行代码或简短语句的说明。

  • 用于解释某一行或紧接着的代码的作用,比如变量用途、逻辑意图
  • 通常放在被注释代码的上方或右侧,上方更推荐
  • 避免过度注释显而易见的代码,如 // 增加i的值 这类冗余说明
  • 连续多行注释建议每行都用 //,保持风格统一

示例:

// 计算圆的面积
double radius = 5.0;
double area = M_PI * radius * radius; // 使用公式 πr²

块注释 /* ... */ 的使用规范

适合用于多行说明、函数说明、版权信息或临时禁用代码块。

立即学习C++免费学习笔记(深入)”;

Loomi
Loomi

全球首个AI社媒内容多智能体系统

下载
  • 常用于函数或类的说明,描述功能、参数、返回值等(但更推荐用Doxygen风格)
  • 可以跨行,适合大段文字说明
  • 不能嵌套,/* /* 内层 */ 外层 */ 会导致编译错误
  • 调试时可用于“注释掉”一段代码,但完成后应清理

示例:

/*
* 计算斐波那契数列第n项
* 参数: n 必须为非负整数
* 返回: 第n项的值,时间复杂度 O(2^n)
*/
int fib(int n) {
if (n return fib(n - 1) + fib(n - 2);
}

如何选择注释方式

根据实际场景选择更合适的注释形式,保持项目内统一。

  • 日常代码说明优先使用 //,简洁清晰
  • 需要跨行文档化时用 /* ... */,尤其是配合文档生成工具
  • 团队开发应制定注释规范,比如Doxygen注释统一用 /** ... */
  • 避免在代码中遗留被注释掉的“死亡代码”,应及时删除

基本上就这些。注释的核心是帮助理解,而不是堆砌文字。保持简洁、准确、及时更新,才是良好注释的关键。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

847

2023.08.22

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1071

2023.08.02

int占多少字节
int占多少字节

int占4个字节,意味着一个int变量可以存储范围在-2,147,483,648到2,147,483,647之间的整数值,在某些情况下也可能是2个字节或8个字节,int是一种常用的数据类型,用于表示整数,需要根据具体情况选择合适的数据类型,以确保程序的正确性和性能。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

617

2024.08.29

c++怎么把double转成int
c++怎么把double转成int

本专题整合了 c++ double相关教程,阅读专题下面的文章了解更多详细内容。

335

2025.08.29

C++中int的含义
C++中int的含义

本专题整合了C++中int相关内容,阅读专题下面的文章了解更多详细内容。

235

2025.08.29

c++怎么把double转成int
c++怎么把double转成int

本专题整合了 c++ double相关教程,阅读专题下面的文章了解更多详细内容。

335

2025.08.29

C++中int、float和double的区别
C++中int、float和double的区别

本专题整合了c++中int和double的区别,阅读专题下面的文章了解更多详细内容。

108

2025.10.23

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

90

2026.03.13

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

136

2026.03.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C# 教程
C# 教程

共94课时 | 11.5万人学习

C 教程
C 教程

共75课时 | 5.5万人学习

C++教程
C++教程

共115课时 | 22.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号