关于代码规范的这些事
代码的格式是给自己和队友看的,因为编译器丝毫不关心代码的格式和注释。
1.大括号风格问题:
第一种风格是每个开始大括号独占一行:
if ()
{
if ()
{
}
else
{
}
}
第二种风格被称为K&R大括号:
if (){
if (){
}
else{
}
}
第一种风格在我看来最容易阅读,主要是其对称的结构。我在网上和身边的朋友更喜欢第二种,他们看来第二种更加紧凑,也更加好阅读,但是我试用过一段时间,发现使用第二种风格时产生了几次由于大括号排序引起的bug,而我用第一种时确没有这种情况,虽然看起来是没K&R节省空间,但是编译器不关心这个问题,主要是看个人习惯。
只是个人在第一种大括号没有遇到大括号排序产生的bug所以推荐第一种。
2.注释怎么写美观一点:
注释常用的也有两种风格,
一种是在代码的后面紧跟注释:
M_MoveSpeed--;// 按下左键,数量减一
另一种是在代码上面写注释:
// 按下左键,数量减一
M_MoveSpeed--;
我一开始的时候是全局用第一种的,后来发现在一些逻辑复杂的代码后面都要写上很长一句话,非常影响阅读,虽然看起来是简洁一点。
我推荐的是在对象定义时使用第一种方法,也就是在对象定义完后紧跟后面写注释,而对象的描述通常短短几个字就行,避免了过长问题,这样简洁且方便查看。
在函数的实现处则在其前面书写注释,这样一长串的说明就不会超出屏幕范围。
3.团队的命名规范:
不管是不是团队开发都应该做好规范,这个有利于管理,特别是导入资源,资源有相同的前缀很重要,有成百上千个文件,用循环寻找无疑快很多。
一个重要的问题是,只要团队的命名规范被定了下来,不管有多烂都要坚决执行。
下面是我的一些规范,可以参考一下,命名规范这个东西主要是先确定下来,然后刻意修行,最后养成习惯。
成员变量:M_
全局变量:G_
虚函数: V_
文本对象:Txt_
图片对象:Img_
等。