我所习惯的代码规范

Posted xjwq

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了我所习惯的代码规范相关的知识,希望对你有一定的参考价值。

其实代码规范不是一朝一夕就能养成习惯的,都是通过多敲多练习自己摸索出来的,也是个人习惯而已。

我所习惯的代码规范有以下几条:

1. 首先是空行。

空行可以使自己的代码更加清晰,有理有据,给其他人看的时候也是可以看得明白的,而且自己在找bug的时候,都是可以非常清楚地看出自己的错误,并且及时改正。

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

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

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

2.其次是符号的一一对应和成对出现。

自己的习惯是花括号上下对齐,另起一行。不要写完左括号然后写内容最后再补右括号,这样很容易漏掉右括号,尤其是写嵌套程序的时候。

3.然后是空格。

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

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

4.再就是缩进。

适当的缩进会让你的代码看起来更高大上,哈哈哈哈哈,而且更清晰明了,更有层次感。

5.最后是注释。

之前我是没有注释的习惯的,嫌麻烦,但是后来发现这样是不对的,注释可以帮助你以后看自己的代码会理解写的是什么,而且功能也清楚,便于阅读。

小结:

要想把代码写规范不是一朝一夕的事,这应该是一种习惯,需要不停地敲、不停的积累。刚开始的时候多模仿,照着规范写就行了,以后在写代码的时候,情不自禁地就会按规范的方式书写了。

 

 

以上是关于我所习惯的代码规范的主要内容,如果未能解决你的问题,请参考以下文章

为了写好代码,你坚持了哪些好习惯?

为了写好代码,你坚持了哪些好习惯?

为了写好代码,你坚持了哪些好习惯?

IDEA 代码规范插件

我的编码习惯 - 参数校验和国际化规范

OC代码规范的spacecommander使用