[C++]项目中的代码注释规范（整理）

最新推荐文章于 2025-04-30 09:58:25 发布

请叫我汪海

最新推荐文章于 2025-04-30 09:58:25 发布

阅读量1w

点赞数 4

分类专栏： C++

本文链接：https://blog.csdn.net/pleasecallmewhy/article/details/8658795

版权

本文详细整理了C++项目中关于代码注释的规范，包括版权信息、作者标识、编写日期和功能描述，确保注释清晰、简洁且不超过80字符宽度。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1 源文件头部注释

列出：版权、作者、编写日期和描述。

每行不要超过80个字符的宽度。

示例：

/*************************************************

Copyright:Call_Me_Why

Author:why

Date:2010-08-25

Description:Something about C++

**************************************************/

2 函数头部注释
列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。
示例：下面这段函数的注释比较标准，当然，并不局

最低0.47元/天解锁文章

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

请叫我汪海

关注关注

4
点赞
踩
13

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

专栏目录

c++ doxygen 注释规范_转:基于 Doxygen 的 C++ 注释风格

weixin_39800971的博客

12-23

475

Title: 基于 Doxygen 的 C++ 注释风格Date: 2015-01-13 18:00Category: LinuxTags: C++, comment styleSlug: doxygen_cpp_comment_styleAuthor: Qian GuSummary: 总结基于 Doxygen 的 C++ 注释规则本文内容参考自网上博客内容重新整理排版了一下。写本文的主要目的是备...

c++代码规范

11-30

### C++代码规范详解 #### 一、文件结构 **1. 文件开头注释：** 在每个源文件或头文件的开头，应包含一个注释块来标识文件的基本信息，如文件名、作者、日期等。这样的注释有助于追踪代码的来源及版本控制。 ...

参与评论您还未登录，请先登录后发表或查看评论

C++注释规范

08-31

对C++代码的注释种类，注释原则，规范细则进行了详细描述

【C++编程规范六】代码注释篇 | 资深工程师的编程秘籍

最新发布

Zy100Papa的博客

04-30

784

【代码】【C++编程规范】C++ 注释规范黄金法则｜资深工程师的编程秘籍。

C++代码注释规范（整理）

08-03

2022

C++代码注释规范（整理） 2010-09-02 16:37 最近一直在给项目代码加注释，因为结项有一项工程性的要求是注释占到总行数的额50%，这几天可苦了我们几个。前几天为了统一项目组的注释规范，专门整理了一份，以后可能也用得着，放着备份下。 1 源文

C C++代码注释规范

Python_Alice的博客

10-17

1712

1.标注总述 //------------------------------------------------------------------- // Platform Defines //------------------------------------------------------------------- enum { OST_PLATFORM_WIN32 = 1, OST_PLATFORM_LINUX_X86 = 2, OST_

Google-C++编码规范中文版（最新整理PDF版）

10-17

Google-C++编码规范中文版详细涵盖了编写高质量C++代码的规则和建议，它为开发者提供了一个清晰的编程风格指南，以便在Google开源项目中使用。规范内容详尽，从文件组织、命名规则到代码风格，从语法细节到注释习惯...

Google_C++编码规范_中文版.pdf

05-16

#### 六、代码注释 - **注释的重要性**：提供清晰的注释可以帮助他人理解代码的功能和逻辑，提高代码的可维护性。 - **代码块注释**：对于复杂的算法或逻辑，使用块注释进行详细说明。 - **单行注释**：对于简单的...

个人C++注释规范

weixin_33985679的博客

09-02

177

一、文章来由好久没写博客了，最近都在做项目，在做项目的过程中遇到多种注释的问题，现在就理清一个注释规范，以后我就按照这个规范来注释~~养成好的注释习惯有助于提高代码的可读性（注：每个人的习惯不同，可找到自己喜欢的注释风格）二、具体规范有的项目可能要求注释占到总行数的额50%。 2.1 源文件头部注释 Ø 列出...

c++的注释格式规范

02-19

1. ##fhd 版权所有 (C), 2010-$YEAR$, ****有限公司文件名 : $FILE$ 版本号 : 初稿作者 : zhujun/016660 生成日期 : $YEAR$年$MONTH$月$DAY$日最近修改 : 功能描述 : $end$ $selected$ 函数列表 : 修改历史 : 1.日期 : $DATE$ $HOUR$:$MINUTE$:$SECOND$ 作者 : zhujun/016660 修改内容 : 创建文件 *****************************************************************************/

C++注释规范~~~~

10-20

注释的目的是使读者在思想上形成一个概念，从而正确地理解程序。说明程序功能并描述程序各组成部分相互关系的高级注释是最有用的，而逐行解释程序指令如何工作的低级注释则不利于读、写和修改，是不必要的，也是难以维护的

注释分析都非常详细的c++ 源代码基础篇

09-04

这些程序是我自己一个一个写的，现拿出来让和我一样的初学者分享一下，用的是dev C++ 编译，里面包括详细的分析过程和代码注释，有两个文件，一个是c++/c 基础的，另一个是基础提高篇，我相信对初学者是有很大的帮助的！同时里面有运行的图片，下载的同学可以先看题目，然后在自己去做，在和我比较一下思路，我写的不是很好的地方还望赐教

【C/C++ 基本知识注释规范】C/C++中注释方式以及规范

探索C++编程的奥秘，分享深入的技术见解和实践，旨在激发读者创造力与解决问题的思维。

07-04

6470

注释是编译器忽略但对于程序员非常有用的文本。注释通常用于批注代码以供将来参考。在C/C++中，使用注释有三种方法。

C/C++ 注释规范

海明

02-08

211

看C/C++ 注释规范，了解代码规范基于Doxygen平台的注释规范看参考文章链接基于Doxygen平台的注释规范 Doxygen是一种开源跨平台的，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java、Objective-C和IDL语言，部分支持PHP、C#。鉴于Doxygen良好的注释风格，故基于Doxygen以形成自己的注释规范。看参考文章链接链接: link. ...

基于Doxygen文档的C++注释原则

haoliliang88的博客

04-23

727

下载国外的源代码，往往能看到附带的说明文档，文档都有详细的说明，大部分文档都可以通过doxygen这个跨平台软件生成，doxygen并不能随便读取你的C++的注释,必须按照一定的规则才能生成，所以在编写代码时，一定要按照标准写注释，否则会为以后带来许多麻烦下面介绍C++的标注写法，c++不推荐c语言式的/* */风格注释，这里，除了文件头使用这种注释外其余到使用C++风格的注释。标注总述 1.文件...