团队项目开发\编码规范\之一:概述
“程序员、程序员”顾名思义就是来编程序的人员。他们和一般工作人员是一样的,都需要合作,可能为了一个大型项目程序会有十人以上或者百人以上甚至千人以上的团队公司在一起工作。编码规范使程序规范化,易懂化,才能更好的进行合作。
开发程序的软件很多。但是它们的检查方式全是检查语法,并没有规定变量命名以及方法的命名,所以注释是很必要的东西,不过如果你将变量命名的规范一些。 Java和C#里的命名是最接近自然语言的 缺点是名字太长,你不喜欢你的老板,但是你得从老板手里赚钱,这就是道理。
喜欢是一回事,赚钱是另外一回事,找既喜欢,又赚钱的事情做,太难了。命名其实是越长越好的,因为表意性很好,大家看了像看文章一样,一目了然。这样才会使得别人更加明白清晰的看清你写程序的思路。
很多人忌讳写长名字,主要原因,可能还是怕敲起来麻烦。现在我们在学校用的visual studio 2005其实有很方便的拷贝功能,事实上,我的变量名,函数名,都只敲一遍,以后全部是拷贝+粘贴。
这样还有一个好处,就是我写的代码,永远不会有笔误,不会因为我敲错一个字符而导致bug。用一个好的习惯,解决整整一个方面的bug,你说划算不划算?如果你对英语并不是特别熟悉,你可以去看看金山词霸,在里面又背英语又进行编码规范的训练挺好。再说你选择了程序员这条路,英语简直是关键中的关键。
编码规范第一、能使你的代码更加易于维护,程序并不是一次性的产品,它需要扩展和修改还有维护的。但是进行这次操作的人并一定就是你了,所以你为了你的接班人也要将规范编码进行到底!
编码规范第二、可以提高代码质量,谁编程都不是一次性完成的,是需要不断的测试与调试,以各种状态来修改自己的代码,而将代码规范化,就能对程序本身有更加清晰的结构思路,从而减少调试而成为快捷高效的代码。
编码规范第三、也是最为重要的是将你本身个性化溶于团队化的过程,当你熟练运用编码规范了,就等于在以后的职场的道路上更加宽广。
编码规范是一种习惯,所以一开始习惯不养好,永远写不出工程型代码。
1.1术语定义 1.1.1 Pascal大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如: BackColor
团队项目开发\编码规范\之二:代码外观 2.1 列宽
代码列宽控制在110字符左右。
2.2 换行
当表达式超出或即将超出规定的列宽,遵循以下规则进行换行 1、在逗号后换行; 2、在操作符前换行;
3、规则1优先于规则2。
2.3 缩进
缩进应该是每行一个Tab(4个空格),不要在代码中使用Tab字符。
2.4 空行
空行是为了将逻辑上相关联的代码分块,以便提高代码的可阅读性。 在代码中,不能包含多个空行。
在以下情况下使用一个空行
1、方法与方法、属性与属性之间。 2、方法中变量声明与语句之间。 3、方法与方法之间。 4、方法中不同的逻辑块之间。
5、方法中的返回语句与其他的语句之间。 6、属性与方法、属性与字段、方法与字段之间。
7、注释与它注释的语句间不空行,但与其他的语句间空一行。
2.5 空格
在以下情况中要使用到空格
1、 关键字和左括符 “(” 应该用空格隔开。如while (true)
注意:在方法名和左括符“(”之间不要使用空格,这样有助于辨认代码中的方法调用与关键字。
2、 多个参数用逗号隔开,每个逗号后都应加一个空格。
3、 除了 .之外,所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与
操作数间不需要空格。如
a += c + d;
a = (a + b) / (c * d); while (d++ = s++) { n++; }
PrintSize(“size is “ + size + “\\n”);
4、 语句中的表达式之间用空格隔开。如
for (expr1; expr2; expr3)
2.6 括号- ()
1、 左括号“(”不要紧靠关键字,中间用一个空格隔开。 2、 左括号“(” 与方法名之间不要添加任何空格。 3、 没有必要的话不要在返回语句中使用()。如
if (condition)
Array.Remove(1)
return 1
2.7 花括号 - {}
1、左花括号 “{” 放于关键字或方法名的下一行并与之对齐。如
if (condition) { }
public int Add(int x, int y) { }
2、 左花括号 “{” 要与相应的右花括号 “}”对齐。
3、通常情况下左花括号 “{”单独成行,不与任何语句并列一行。
4、 if、while、do语句后一定要使用{},即使{}号中为空或只有一条语句。如
if (somevalue == 1) {
somevalue = 2; }
5、右花括号 “}” 后建议加一个注释以便于方便的找到与之相应的 {。如
while (1)
{
if (valid) { } else { } // if } // while
百度搜索“77cn”或“免费范文网”即可找到本站免费阅读全部范文。收藏本站方便下次阅读,免费范文网,提供经典小说综合文库团队项目开发编码规范在线全文阅读。
相关推荐: