(c语言必背100行代码)(c语言100行代码大全)

C语言代码规范是一种人为的、约定成俗的编程标准,旨在保证代码的清晰、简洁、可测试、安全、程序效率和可移植性。

不同的项目或组织可能有不同的C语言代码规范,但是一般都会涉及以下几个方面:

- 文件排版:如何组织头文件、源文件、空行等。

- 注释:如何给文件、函数、变量等添加有意义的注释。

- 命名:如何给标识符、变量、函数、类等命名,以及如何使用大小写、下划线等。

- 代码风格:如何使用空格、缩进、括号等,以及如何编写表达式、控制语句等。

下面是C语言代码规范总结的示例:

### 文件排版

- 头文件应该包含文件头注释,说明文件的作者、名称、功能和生成日期等信息。

- 头文件应该使用 #ifdef 控制块,避免重复包含。

- 头文件应该只包含接口的声明,不包含实现细节。

- 头文件应该职责单一,避免过多的依赖关系。

- 源文件应该包含对应的头文件,以及必要的系统头文件和用户头文件。

- 源文件应该按照包含指令、宏定义、全局变量和函数定义的顺序组织内容。

- 源文件和头文件的命名应该使用英文单词或其组合,大小写混合或小写混合,例如 DiyMainView.cpp , infoview.h 。

- 系统头文件应该使用尖括号 #include <xxx.h> ,用户头文件应该使用双引号 #include "xxx.h" 。

### 注释

- 注释应该使用英文或中文,避免使用拼音或其他语言。

- 注释应该简洁明了,说明代码的功能和逻辑,而不是重复代码本身。

- 注释应该紧跟在被注释的代码之前或之后,不要放在代码行之后。

- 注释应该使用 // 或 /* ... */ 的形式,不要使用 /// 或 /** ... */ 的形式。

- 注释应该给出每个函数的用途、参数和返回值等信息。

- 注释应该给出每个类的功能和成员变量等信息。

- 注释应该给出每个宏、常量和类型定义等信息。

- 注释应该给出每个 #else 或 #endif 的对应条件。

- 注释应该给出未实现或需要优化的代码,使用 // TODO ... 的形式。

- 注释应该给出调试或需要注意的代码,使用 // only for DEBUG 或 // NOTE ... 的形式。

### 命名

- 命名应该使用英文单词或其组合,避免使用缩写或无意义的名称。

- 命名应该直观且可以拼读,可望文知意,用词应当准确。

- 命名应该最小化长度和最大化信息量,避免过长或过短的名称。

- 命名应该避免过于相似或重复,例如 i 和 I , function 和 Function 等。

- 命名应该正确反映互斥或相反的意义,例如 nMinValue 和 nMaxValue , GetName () 和 SetName () 等。

- 命名应该遵循一定的前缀或后缀规则,例如 T 表示简单数据类型, C 表示从 CBase 继承的类, M 表示接口类, R 表示资源类, L 表示 Leave 函数, a 表示函数参数, m 表示成员变量, g_ 表示全局变量等。

### 代码风格

- 代码风格应该保持一致,遵循项目或组织的规范。

- 代码风格应该使用空格而不是 Tab 来进行缩进,每个缩进级别为 4 个空格。

- 代码风格应该在运算符、分隔符、关键字等符号前后加上空格,例如 a + b , if (x == y) 等。

- 代码风格应该在花括号 { 和 } 前后换行,除非是空的花括号 {} 。

- 代码风格应该在每个语句后加上分号 ; ,即使是单行的 if 或 for 语句。

- 代码风格应该在每个 case 分支后加上 break 或 return ,避免意外的穿透。

- 代码风格应该在每个函数或类体之间用两个空行分隔,除非有特殊情况。

- 代码风格应该在较大的代码块结尾加上 // end for|while|do|if|switch 等注释。

声明:我要去上班所有作品(图文、音视频)均由用户自行上传分享,仅供网友学习交流,版权归原作者霸都嵌入式所有,原文出处。若您的权利被侵害,请联系删除。

本文标题:(c语言必背100行代码)(c语言100行代码大全)
本文链接:https://www.51qsb.cn/article/m9gu6.html

(0)
打赏微信扫一扫微信扫一扫QQ扫一扫QQ扫一扫
上一篇2023-07-11
下一篇2023-07-11

你可能还想知道

发表回复

登录后才能评论