对于程序员来说，养成良好的代码写作能力是非常重要的。
成都创新互联是一家专注于做网站、网站设计与策划设计,献县网站建设哪家好?成都创新互联做网站,专注于网站建设十余年,网设计领域的专业建站公司;建站业务涵盖:献县等地区。献县做网站价格咨询:18982081108
今天，我们就一起来了解一下，规范化的代码编写都有哪些要求。
希望通过对本文的阅读，能够提高大家对于代码规范的认识。
1.保证代码压缩后不出错对于大型的JSP项目，一般会在产品发布时对项目包含的所有JSP文件进行压缩处理，比如可以利用GoogleClosureCompilerService对代码进行压缩，新版jQuery已改用这一工具对代码进行压缩，这一般会去掉开发时写的注释，除去所有空格和换行，甚至可以把原来较长的变量名替换成短且无意义的变量名，这样做的目的是加快文件的下载速度，同时也减小网站访问带来的额外数据流量，另外在代码保护上也起到了一点点作用，至少压缩后的代码即使被还原还是没那么容易一下读懂的。
要想代码能正确通过压缩，一般要求语句都要以分号正常结束，大括号也要严格结束等，具体还要看压缩工具的要求。
所以如果一开始没有按标准来做，等压缩出错后再回去找错误那是浪费时间。
2.保证代码能通过特定IDE的自动格式化功能一般较为完善的开发工具(比如AptanaStudio)都有代码"自动格式"化功能，这一功能帮助实现统一换行、缩进、空格等代码编排，你可以设置自己喜欢的格式标准，比如左大括号{是否另起一行。
达到这个要求的目的在于方便你的开发团队成员拿你代码的一个副本用IDE自动格式化成他喜欢或熟悉的风格进行阅读。
你同事需要阅读你的代码，可能是因为你写的是通用方法，他在其它模块开发过程中也要使用到，阅读你的代码能深入了解方法调用和实现的细节，这是简单API文档不能达到的效果。
3.使用标准的文档注释这一要求算是基本的，这有利于在方法调用处看到方法的具体传参提示，也可以利用配套文档工具生成html或其它格式的开发文档供其他团队成员阅读，你可以尝试使用jsdoc-toolkit。
如果你自动生成的API是出自一个开放平台，就像facebook.com应用，那么你的文档是给天下所有开发者看的。
另外编写完整注释，也更方便团队成员阅读你的代码，通过你的参数描述，团队成员可以很容易知道你编写的方法传参与实现细节。
当然也方便日后代码维护，这样即使再大的项目，过了很长时间后，回去改点东西也就不至于自己都忘记了当时自己写的代码是怎么一回事了。
4.使用规范有意义的变量名使用规范有意义的变量名可以提高代码的可读性，作为大项目开发成员，自己写的代码不仅仅要让别人容易看懂。
电脑培训认为开发大项目，其实每个人写的代码量可能都比较大，规范命名，日后自己看回自己的代码也显的清晰易懂，比如日后系统升级或新增功能，修改起代码来也轻松多了。
如果到头发现自己当初写的代码现在看不太懂了，那还真是天大的笑话了。
一、不要使用魔法数字，尽量定义枚举、常量、宏：
我常常见到表示各种状态的数字，0，1，2....，我真的不知道这表示什么含义，如果
你在不在文档中说明的话，这个东东过几天连你自己都不知道个一二三了。
二、命名要具有描述力，尽量使用全名而不是自创的缩写，除非地球人都这么用这个缩写：
我常常看到一些自创的缩写，这个缩写或许只有你自己知道，类名，方法名，参数名
尤其要有好的描述里，局部变量尚可容忍。我宁可容忍超过40个字符的命令，也不愿意
看到只有一两个字母的命名，当然迭代用的i,j除外。当然命名不要太长，太长说明你的类和
方法要做的事情太多，请你拆分出更多细粒度功能单一的类和方法。
三、同一类东东命名方式尽可能统一，比如类名使用大写字母开头的单词，变量使用
下划线分割开来的小写字母单词，常量使用下滑线分割的开来的大写字母单词。不要
交替使用。
四、函数、类功能尽可能单一，不要试图写一个万能/超级函数或者类。
一个类和方法要有单一的职责，这样的类和方法只做一件事，并且容易把他做好。
1、不要试图写一个强大无比的方法。
我常常看到一些试图写的多么“精妙”无比多么“强大”的函数，事实上不是什么精妙，而是
代码的臭味道。精妙强大无比万能的方法往往你耗费大量精力去设计算法，试图覆盖现在的各
种可能，而无法面对将来新的需求，随着新的需求，你的这个精妙的方法需要的修改并且改起来
极其痛苦。在一次次的痛苦与精妙的演化中，你的方法越来越复杂，并且每一次修改你都会面
临影响以前功能的风险。这个方法使用者需要小心的处理你的精妙之处，如果没有精妙传递好参
数，那么这个方法再也不精妙了，而是直接废掉了。
KISS（keep it simple and stupid）原理就是这个道理，你要使你的代码尽可能简单，让人
看到有一目了然的清爽，而不是因为设计了一个精妙无比的万能方法而沾沾自喜。这里的简单不是
简洁的代名字。有时候简洁是那种传说的“精妙”的代码。
2、不要写做多件事情的方法和类，你做一件事情，你就写一个对应的方法，不要试图通过参数来判定各种情况，然后做事情，并且做的事情和你方法描述的不一致。当你发现你的方法名字想不出来好的名字了，或者要加or和and了，那么请你拆分出更多单一的方法。
不要举一些linux完成多种功能系统调用，这是被迫的，因为系统调用的数量是有限制的，它只有有限的空间来描述系统调用号和系统调用的映射表，不要在应用程序开发中效仿而误以为优雅强大。我最恶心根据参数，然后一大堆的if..else 和switch..case判断。
五、不要修改已有的类和方法而是扩展它。
这是程序设计的一个重要原则，开闭原则，在面向对象的语言中尤为重要。在面向过程中主要表现在，不要在一个函数要应对和这个函数相似的一个需求了，就在这个加个if，来修改这个方法，试图重用和避免重复。而是要把公用的部分抽出来成一个小的功能函数，然后增加一个应对新的类似这个需求的处理方法。在面向对象中，例如使用策略模式、访问者模式、Extend Object模式。
六、不要重复你自己（DRY）：
程序最怕的是copy,paste，到处是重复的代码。copy，paste经常被误以为快速完成需要用的功能的高效方式而被到处使用。你每重复一次，你就得负责保持他们的一致性，你就得在一处增加新的功能时，你就的把这个的功能加到其他地方。还在我刚会写代码的时候去了一个小公司，他们的代码到处是copy，paste的痕迹，当要在现有的功能增加审计功能是，他们开始下命令了，每个人加几行代码来做审计，真不知道那么多人写的审计版本，分散到那么多处，这个审计功能是否可信有用。
避免DRY的方法就是抽象，分离变化。不管是面向对象还是面向过程，分离变化并抽象之是最主要的设计原则。设计模式中的模板方法，我们常用的回调都是我们常用的方法。
我发现越是提供更多回调处理的语言和框架，就越具有灵活性和易用性。ruby语言之所以有如此的威力，主要是因为它提供了更多的回调处理。它可以在动态的给一个类增加方法，这样可以在超类中定义增加方法的方法，然后再子类调用，子类就具有无比的能力。它的block提供了强大的回调机制，我只要不知道如何处理了我就yield出来，method missing机制更是神秘无比，你可以写出像find_by_name_and_age,2.days.ago这样像自然语言一样易读的代码。
七、不要跨越边界，在适合的地方写代码。
在分层的架构中，不要跨越层的边界。例如web开发的三层架构:
数据访问层（DAO)、业务层(Service)、表现层。
不要在业务层裸写SQL来做事情，不要在业务层掺和进来表现层的东东，不要在表现层/控制器中写业务的东东。既然已经分层了，那么就要好好的遵守它，如果到处跨越边界的话，那么和不分层没有什么区别，使得每一层都不伦不类。例如你应该在业务层进行事务管理，而你的控制器到处是业务代码，那将无法控制。如果你的业务层到处是SQL，我不知道你的DAO存在的意义了。
八、分层的web架构：
DAO层最好按照模型来划分dao类，如果业务很简单，也可以将相关的模型合并为一个DAO。
Service层，不要按照DAO和Service一一对应的方式划分，而是要按照业务的类别和实际情况来划分。事实上Service层通常是用来处理涉及到多个模型的业务，而涉及到一个模型的业务，常常被放在模型中，这是一种自然而更面向对象的设计方法。只有数据的模型被称为贫血型模型，这种模型被认为是对面向对象的一种背离，而在模型中放置专有的业务方法，不仅有利于公用，而且模型更具有描述力。
九、关于MVC:
MVC是一种松耦合的设计方案，最容易误用的就是控制器（c）。控制器只负责调用业务方法，准备好数据供View去展现。而不要把业务和如何展示的东东放在里面。我常常看到有人在控制器中拼html片段和写一些业务相关的代码。
十、顺便说一下异常的使用。
如果你是使用语言支持异常机制，那么尽可能的使用异常机制和定义好与自己业务相关的异常，而不是通过返回值表示正确和错误。如果你使用的语言支持异常机制，请不要写类linux下c似的代码形式，每写一个函数，我就写一个判断返回值调用是否成功，严重分离了我对核心业务的关注。异常提供了优雅的处理错误的方法。
1、组织与风格
(1).关键词和操作符之间加适当的空格。
(2).相对独立的程序块与块之间加空行
(3).较长的语句、表达式等要分成多行书写。
(4).划分出的新行要进行适应的缩进，使排版整齐，语句可读。
(5).长表达式要在低优先级操作符处划分新行，操作符放在新行之首。
(6).循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分。
(7).若函数或过程中的参数较长，则要进行适当的划分。
(8).不允许把多个短语句写在一行中，即一行只写一条语句。
(9).函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。
注：如果大家有兴趣可以到安安DIY创作室博客，有相关说明性的文章和解释。
2、注解
Java 的语法与 C++ 及为相似，那么，你知道 Java 的注释有几种吗？是两种？
// 注释一行
/* ...... */ 注释若干行
不完全对，除了以上两种之外，还有第三种，文档注释：
/** ...... */ 注释若干行，并写入 javadoc 文档
注释要简单明了。
String userName = null; //用户名
边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。
在必要的地方注释，注释量要适中。注释的内容要清楚、明了，含义准确，防止注释二义性。
保持注释与其描述的代码相邻，即注释的就近原则。
对代码的注释应放在其上方相邻位置，不可放在下面。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释应放在此域的右方；
同一结构中不同域的注释要对齐。
变量、常量的注释应放在其上方相邻位置或右方。
全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。
在每个源文件的头部要有必要的注释信息，包括：文件名；版本号；作者；生成日期；模块功能描述（如功能、主要算法、内部各部分之间的关系、该文件与其它文件关系等）；主要函数或过程清单及本文件历史修改记录等。
/**
* Copy Right Information : Neusoft IIT
* Project : eTrain
* JDK version used : jdk1.3.1
* Comments : config path
* Version : 1.01
* Modification history :2003.5.1
* Sr Date Modified By Why What is modified
* 1. 2003.5.2 Kevin Gao new
**/
在每个函数或过程的前面要有必要的注释信息，包括：函数或过程名称；功能描述；输入、输出及返回值说明；调用关系及被调用关系说明等
/**
* Description :checkout 提款
* @param Hashtable cart info
* @param OrderBean order info
* @return String
*/
public String checkout(Hashtable htCart,
OrderBean orderBean)
throws Exception{
}
javadoc注释标签语法
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向，也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
3、命名规范
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性）较短的单词可通过去掉元音形成缩写；要不然最后自己写的代码自己都看不懂了，那可不行。
较长的单词可取单词的头几发符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。
使用匈牙利表示法
Package 的命名
Package 的名字应该都是由一个小写单词组成。
package com.neu.util
Class 的命名
Class 的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。
public class ThisAClassName{}
Class 变量的命名
变量的名字必须用一个小写字母开头。后面的单词用大写字母开头
userName , thisAClassMethod
Static Final 变量的命名
static Final 变量的名字应该都大写，并且指出完整含义。
/**
*DBConfig PATH
**/
public static final String
DB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig;
参数的命名
参数的名字必须和变量的命名规范一致。
数组的命名
数组应该总是用下面的方式来命名：
byte[] buffer;
而不是：
byte buffer[];
方法的参数
使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：
SetCounter(int size){
this.size = size;
}
4、文件样式
所有的 Java(*.java) 文件都必须遵守如下的样式规则：
版权信息
版权信息必须在 java 文件的开头，比如：
/*
* Copyright ? 2000 Shanghai XXX Co. Ltd.
* All right reserved.
*/
其他不需要出现在 javadoc 的信息也可以包含在这里。
Package/Imports
package 行要在 import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母
顺序排列。如果 import 行中包含了同一个包中的不同子目录，则应该用 * 来处理。
package hotlava.net.stats;
import java io.*;
import java.util.Observable;
import hotlava.util.Application;
这里 java。io.* 使用来代替InputStream and OutputStream 的。
Class
接下来的是类的注释，一般是用来解释类的。
/**
* A class representing a set of packet and byte counters
* It is observable to allow it to be watched, but only
* reports changes when the current set is complete
*/
接下来是类定义，包含了在不同的行的 extends 和 implements
public class CounterSet
extends Observable
implements Cloneable
Class Fields
接下来是类的成员变量：
/**
* Packet counters
*/
protected int[] packets;
public 的成员变量必须生成文档（JavaDoc）。proceted、private和 package 定义的成
员变量如果名字含义明确的话，可以没有注释。
存取方法
接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话，可以简单的
写在一行上。
/**
* Get the counters
* @return an array containing the statistical data. This array has been
* freshly allocated and can be modified by the caller.
*/
public int[] getPackets() { return copyArray(packets, offset); }
public int[] getBytes() { return copyArray(bytes, offset); }
public int[] getPackets() { return packets; }
public void setPackets(int[] packets) { this.packets = packets; }
其它的方法不要写在一行上
构造函数
接下来是构造函数，它应该用递增的方式写（比如：参数多的写在后面）。
访问类型 (public, private 等.) 和 任何 static, final 或 synchronized 应该在一行
中，并且方法和参数另写一行，这样可以使方法和参数更易读。
public
CounterSet(int size){
this.size = size;
}
克隆方法
如果这个类是可以被克隆的，那么下一步就是 clone 方法：
public
Object clone() {
try {
CounterSet obj = (CounterSet)super.clone();
obj.packets = (int[])packets.clone();
obj.size = size;
return obj;
}catch(CloneNotSupportedException e) {
throw new InternalError(Unexpected CloneNotSUpportedException: +
e.getMessage());
}
}
类方法
下面开始写类的方法：
/**
* Set the packet counters
* (such as when restoring from a database)
*/
protected final
void setArray(int[] r1, int[] r2, int[] r3, int[] r4)
throws IllegalArgumentException
{
//
// Ensure the arrays are of equal size
//
if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length)
throw new IllegalArgumentException(Arrays must be of the same size);
System.arraycopy(r1, 0, r3, 0, r1.length);
System.arraycopy(r2, 0, r4, 0, r1.length);
}
toString 方法
无论如何，每一个类都应该定义 toString 方法：
public
String toString() {
String retval = CounterSet: ;
for (int i = 0; i data.length(); i++) {
retval += data.bytes.toString();
retval += data.packets.toString();
}
return retval;
}
}
main 方法
如果main(String[]) 方法已经定义了, 那么它应该写在类的底部.
5、代码可读性
避免使用不易理解的数字，用有意义的标识来替代。
不要使用难懂的技巧性很高的语句。
源程序中关系较为紧密的代码应尽可能相邻。
6、代码性能
在写代码的时候，从头至尾都应该考虑性能问题。这不是说时间都应该浪费在优化代码上，而是我们时刻应该提醒自己要注意代码的效率。比如：如果没有时间来实现一个高效的算法，那么我们应该在文档中记录下来，以便在以后有空的时候再来实现她。
不是所有的人都同意在写代码的时候应该优化性能这个观点的，他们认为性能优化的问题应该在项目的后期再去考虑，也就是在程序的轮廓已经实现了以后。
不必要的对象构造
不要在循环中构造和释放对象
使用 StringBuffer 对象
在处理 String 的时候要尽量使用 StringBuffer 类，StringBuffer 类是构成 String 类的基础。
String 类将 StringBuffer 类封装了起来，（以花费更多时间为代价）为开发人员提供了一个安全的接口。当我们在构造字符串的时候，我们应该用 StringBuffer 来实现大部分的工作，当工作完成后将 StringBuffer 对象再转换为需要的 String 对象。比如：如果有一个字符串必须不断地在其后添加许多字符来完成构造，那么我们应该使用StringBuffer 对象和她的 append() 方法。如果我们用 String 对象代替StringBuffer 对象的话，会花费许多不必要的创建和释放对象的 CPU 时间。大家可以来安安DIY创作室一起讨论。
避免太多的使用 synchronized 关键字避免不必要的使用关键字 synchronized，应该在必要的时候再使用她，这是一个避免死锁的好方法。
7、编程技巧
byte 数组转换到 characters
为了将 byte 数组转换到 characters，你可以这么做：
Hello world!.getBytes();
Utility 类
Utility 类（仅仅提供方法的类）应该被申明为抽象的来防止被继承或被初始化。
初始化
下面的代码是一种很好的初始化数组的方法：
objectArguments = new Object[] { arguments };
枚举类型
JAVA 对枚举的支持不好，但是下面的代码是一种很有用的模板：
class Colour {
public static final Colour BLACK = new Colour(0, 0, 0);
public static final Colour RED = new Colour(0xFF, 0, 0);
public static final Colour GREEN = new Colour(0, 0xFF, 0);
public static final Colour BLUE = new Colour(0, 0, 0xFF);
public static final Colour WHITE = new Colour(0xFF, 0xFF, 0xFF);
}
这种技术实现了RED, GREEN, BLUE 等可以象其他语言的枚举类型一样使用的常量。
他们可以用 '==' 操作符来比较。
但是这样使用有一个缺陷：如果一个用户用这样的方法来创建颜色 BLACK new Colour(0,0,0)
那么这就是另外一个对象，'=='操作符就会产生错误。她的 equal() 方法仍然有效。由于这个原因，这个技术的缺陷最好注明在文档中，或者只在自己的包中使用。
8、编写格式
代码样式
代码应该用 unix 的格式，而不是 windows 的（比如：回车变成回车+换行）
文档化
必须用 javadoc 来为类生成文档。不仅因为它是标准，这也是被各种 java 编译器都认可的方法。使用 @author 标记是不被推荐的，因为代码不应该是被个人拥有的。
缩进
缩进应该是每行2个空格. 不要在源文件中保存Tab字符. 在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度.如果你使用 UltrEdit 作为你的 Java 源代码编辑器的话，你可以通过如下操作来禁止保存Tab字符, 方法是通过 UltrEdit中先设定 Tab 使用的长度室2个空格，然后用 Format|Tabs to Spaces 菜单将 Tab 转换为空格。
页宽
页宽应该设置为80字符. 源代码一般不会超过这个宽度, 并导致无法完整显示, 但这一设置也可以灵活调整. 在任何情况下, 超长的语句应该在一个逗号或者一个操作符后折行. 一条语句折行后, 应该比原来的语句再缩进2个字符.
{} 对
{} 中的语句应该单独作为一行. 例如, 下面的第1行是错误的, 第2行是正确的:
if (i0) { i ++ }; // 错误, { 和 } 在同一行
if (i0) {
i ++
}; // 正确, { 单独作为一行
} 语句永远单独作为一行.如果 } 语句应该缩进到与其相对应的 { 那一行相对齐的位置。
括号
左括号和后一个字符之间不应该出现空格, 同样, 右括号和前一个字符之间也不应该出现空格. 下面的例子说明括号和空格的错误及正确使用:
CallProc( AParameter ); // 错误
CallProc(AParameter); // 正确
不要在语句中使用无意义的括号. 括号只应该为达到某种目的而出现在源代码中。下面的例子说明错误和正确的用法:
if ((I) = 42) { // 错误 - 括号毫无意义
if (I == 42) or (J == 42) then // 正确 - 的确需要括号
9、代码编译
1.编写代码时要注意随时保存，并定期备份，防止由于断电、硬盘损坏等原因造成代码丢失。
2.同一项目组内，最好使用相同的编辑器，并使用相同的设置选项。
3.合理地设计软件系统目录，方便开发人员使用。
4.打开编译器的所有告警开关对程序进行编译。
5.在同一项目组或产品组中，要统一编译开关选项。
6.使用工具软件（如Visual SourceSafe）对代码版本进行维护。如果大家有不明白的可以到安安DIY创作室留言。
10、可移植性
Borland Jbulider 不喜欢 synchronized 这个关键字，如果你的断点设在这些关键字的作用域内的话，调试的时候你会发现的断点会到处乱跳，让你不知所措。除非必须，尽量不要使用。
换行
如果需要换行的话，尽量用 println 来代替在字符串中使用\n。
你不要这样：
System.out.print(Hello,world!\n);
要这样：
System.out.println(Hello,world!);
或者你构造一个带换行符的字符串，至少要象这样：
String newline = System.getProperty(line.separator);
System.out.println(Hello world + newline);
PrintStream
PrintStream 已经被不赞成（deprecated）使用，用 PrintWrite 来代替它。
