代码规范要求

简介: 代码规范要求

1,代码规范化的七大原则

代码规范化基本上有七大原则,体现在空行、空格、成对书写、缩进、对齐、代码行、注释七方面的书写规范上。

2,空行

定义变量后要空行。尽可能在定义变量的同时初始化该变量,即遵循就近原则。如果变量的引用和定义相隔比较远,那么变量的初始化就很容易被忘记。若引用了未被初始化的变量,就会导致程序出错。

每个函数定义结束之后都要加空行。

两个相对独立的程序块、变量说明之后必须要加空行。比如上面几行代码完成的是一个功能,下面几行代码完成的是另一个功能,那么它们中间就要加空行。这样看起来更清晰。

空格

关键字之后要留空格。像 const、case 等关键字之后至少要留一个空格,否则无法辨析关键字。像 if、for、while 等关键字之后应留一个空格再跟左括号(,以突出关键字。

函数名之后不要留空格,应紧跟左括号(,以与关键字区别。(向后紧跟;)、,、;这三个向前紧跟;紧跟处不留空格。

,之后要留空格。如果;不是一行的结束符号,其后要留空格。

赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符,如 =、==、!=、+=、-=、* =、/=、%=、>>=、<<=、&=、=、|=、>、<=、>、>=、+、-、*、/、%、&、|、&&、||、<<、>>、 等双目运算符的前后应当加空格。

单目运算符 !、~、++、--、-、*、& 等前后不加空格。

注意:

这里的“-”和规则五里面的“-”不同。这里的“-”是负号运算符,规则五里面的“-”是减法运算符。

这里的“ * ”和规则五里面的“ * ”也不同。这里的“ * ”是指针运算符,规则五里面的“ * ”是乘法运算符。

这里的“&”和规则五里面的“ & ”也不同。这里的“ & ”是取地址运算符,规则五里面的“ & ”是按位与运算符。

像数组符号[]、结构体成员运算符.、指向结构体成员运算符->,这类操作符前后不加空格。

对于表达式比较长的 for 语句和 if 语句,为了紧凑起见,可以适当地去掉一些空格。但 for 和 if 后面紧跟的空格不可以删,其后面的语句可以根据语句的长度适当地去掉一些空格。例如:for (i=0; i<10; i++)for 和分号后面保留空格就可以了,=和<前后的空格可去掉。

3,成对书写

成对的符号一定要成对书写,如 ()、{}。不要写完左括号然后写内容最后再补右括号,这样很容易漏掉右括号,尤其是写嵌套程序的时候。

4,缩进

缩进是通过键盘上的 Tab 键实现的,缩进可以使程序更有层次感。原则是:如果地位相等,则不需要缩进;如果属于某一个代码的内部代码就需要缩进。

5,对齐

对齐主要是针对大括号{}说的:

{和}分别都要独占一行。互为一对的{和}要位于同一列,并且与引用它们的语句左对齐。

{}之内的代码要向内缩进一个 Tab,且同一地位的要左对齐,地位不同的继续缩进。

代码行

一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且便于写注释。

if、else、for、while、do 等语句自占一行,执行语句不得紧跟其后。此外,非常重要的一点是,不论执行语句有多少行,就算只有一行也要加{},并且遵循对齐的原则,这样可以防止书写失误。

注释

C语言中一行注释一般采用//…,多行注释必须采用/*…*/。注释通常用于重要的代码行或段落提示。在一般情况下,源程序有效注释量必须在 20% 以上。虽然注释有助于理解代码,但注意不可过多地使用注释。

注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主,注释太多会让人眼花缭乱。

如果代码本来就是清楚的,则不必加注释。

边写代码边注释,修改代码的同时要修改相应的注释,以保证注释与代码的一致性,不再有用的注释要删除。

当代码比较长,特别是有多重嵌套的时候,应当在段落的结束处加注释,这样便于阅读。

每一条宏定义的右边必须要有注释,说明其作用。

相关文章
|
XML 算法 安全
C#编码规范
本篇内容记录了 命名惯例和规范、 ** 良好的编程习惯、** 注释 、 ** 异常处理
578 0
C#编码规范
|
1月前
|
程序员 测试技术
程序员的代码规范需求
程序员的代码规范需求
46 1
|
6月前
|
SQL 存储 安全
代码规范(如何提高代码规范)
在软件开发中,优雅的代码规范对于编写美观且实用的代码至关重要。以下是一些提升代码质量的建议: 1. **命名清晰**:使用描述性强的命名,使代码自解释,减少误解,提高可读性。 2. **简洁性**:用最少的代码实现功能,避免冗余,简洁的代码更易维护。 3. **一致性**:保持命名和编码风格的一致性,降低团队协作成本。 4. **注释**:合理注释解释代码意图,但避免过度注释。 5. **避免复杂性**:将复杂逻辑分解为简单部分,用函数或模块封装。 6. **重构**:定期重构代码以提高可读性和性能。 7. **测试**:编写单元测试确保代码的稳定性和可靠性。
|
6月前
|
数据库
代码规范(一)
代码规范(一)
63 0
|
移动开发 前端开发 JavaScript
|
开发者
代码规范|学习笔记
快速学习 代码规范
152 0
|
SQL C#
C#编码规范——转载
1. 简介 本规范为一套编写高效可靠的 C# 代码的标准、约定和指南。它以安全可靠的软件工程原则为基础,使代码易于理解、维护和增强,提高生产效率。同时,将带来更大的一致性,使软件开发团队的效率明显提高。
3121 0