第三周做业

是否须要有代码规范？

       对于不少“程序猿”来讲，都有着一套只有本身才能看懂得代码格式，相信每一个人都存有本身的观点。好比：

1. 这些规范都是官僚制度下产生的浪费你们的编程时间、影响人们开发效率, 浪费时间的东西。
2. 我是个艺术家，手艺人，我有本身的规范和原则。
3. 规范不能强求一概，应该容许不少例外。
4. 我擅长制定编码规范，大家听个人就行了。

       按我我的的观点来讲，我是反驳以上说法的。首先我对于文本的书写十分注重排版和美观，我认为这就是本身一个“门面”，就像是人们常说的“字如其人”。再者，在软件开发的整个生命同期中，均由最初的开发人员来维护的状况几乎是没有的。因此说让我换位到程序维护这一方来考虑，当你面对眼前“一坨坨”的代码，相信都会忍不住吐槽：“这一坨坨都是个啥@#￥%#￥……”，随后拂袖而去。

       虽然说吐槽声有如滔滔洪水，但建一座堤坝即可将其截流。Yes！it is 代码规范化。提及代码规范，首先要了解其意义。

是用来管理代码格式和风格的文档和规范，要求公司内部统一规范，其中包括：命名规则（数据库字段，表名，存储结构名、函数、变量、文件名等），每行字符数（编译软件每行显示的字符数量，多少个字符换行），缩进的格式（tab仍是四个空格），函数的代码行数等内容。

代码规范同时包括了编码风格和其它规范，不只仅指代码格式。例如，像“返回成功/失败的函数应该用一个整数做为返回值”，这样的规则不属于编码风格。

（一）论代码规范的重要性

1. 促进团队进程。对于一个团队内进行协同开发，程序的维护和复查是全队成员的工做，若是开发人员坚持我的风格进行编写，极可能会形成总体进度和延后。
2. 下降维护成本。一个软件的生命周期中，80%的花费在于维护，规范的代码能够减小编码人员的理解时间，下降维护代价，易于进行二次开发。
3. 可读性加强。编码规范能够改善软件的可读性，可让程序员尽快而完全地理解新代码。
4. 便于产品的发布。若是你将源码做为产品发布，须要按照规范，确认它是否被很好的打包而且清晰无误。

（二）论代码规范的实施性

1. 代码审查。会很大程度的改变程序猿们的编写态度。若是你在编程，并且知道将会有同事检查你的代码，那么你写出的代码将更加整洁，有更好的注释，更好的程序结构。由于你知道，那个你很在乎的人将会查看你的程序。没有代码审查，你知道人们最终仍是会看你的程序。
2. 基本的规范化制度。制度会约束坚持己见的人。
3. 更正编写习惯。尽早的改正本身的编写习惯，将代码规范化。

（三）论代码规范的编写指南

（1）排版规范

1. 程序块采用缩进，缩进空位为4个。
2. 分解符如“{”和“}”独占一行，而且位于同列。
3. 较长的语句、表达式、参数要书写多行。
4. 一行只写一条语句。
5. if,for,do,while,case,switch,default 独占一行，且语句块都要加“{ }”,不管语句多少。
6. 相对独立的业务语句块之间，变量说明后加空行。
7. 对齐只用空格不用TAB，避免不一样编辑器对TAB处理不一样。
8. 对二个以上的关键字、变量、常量进行对等操做时，变量先后必须留空格。
9. 类属性和方法不用交叉放置，不一样存取范围的属性或方法也不远交叉放置。

（2）注释规范

1. 有代码的地方就有注释，杜绝没有任何注释的代码，推荐注释量在20%以上。
2. 包的注释：在包的当前路径放入一名为package.html的HTML文件，方面JavaDoc收集。注释内容简述本包的做用、内容、产品模块、版本、版权等，如：文件注释：文件开始，package 关键字前面，记载版权说明、描述信息、生成日期、修改历史等。
3. 类和接口的注释：在package以后，class或interface以前，描述当前类或接口的功能，做者，生成日期，修改日志，版本号等。
4. 类属性、方法注释：在类或方法的前面，类属性记载属性的功能用处，用/* 开头描述注释，放置JavaDoc收集；类方法注释须要记载方法的功能简述、详细、输入参数、输出值、抛出的异常、做者等。

注意事项

1. 包结构清晰，类、接口、方法、属性命名贴切易懂。
2. 该注释的地方注释，注释清楚、易懂，没有二义性。
3. 接口定义明确，精确方法功能，每一个方法只实现一个功能。
4. 方法内部的代码行数控制在200行之内，一个类的代码行数控制在1000行之内，若是你的类代码在1000行以上，请从新思考设计思路，这里说的代码行数不把注释计算在内。
5. 多个方法内部若是有类似的功能代码块，应该提取为公用方法。
6. 尽可能将业务相近的方法放在一块儿，便于寻找。
7. 方法内部尽可能不要catch异常，让外部调用者知道出错细节。
8. 方法内部对于对象参数的调用，尽可能判断非null引用，除非你的设计能保证非空对象。
9. 不用的数据及时是否，若是数据库链接、集合、共享锁等。
10. 不要使用技巧性比较高的表达式。

       规范的代码有利于帮助咱们理解开发语言的架构，也可以快速提高开发水平，因此更要注重基础习惯的养成。