(JAVA编码规范.docVIP

命名规范尽量使用完整的英文描述符采用适用于相关领域的术语采用大小写混合使名字可读尽量少用缩写，但如果用了，要明智地使用，且在整个工程中统一message的缩写可以为msg。 避免使用长的名字（小于 15 个字母是个好主意）避免使用类似的名字，或者仅仅是大小写不同的名字避免使用下划线（除静态常量等）ackage 的命名ackage 的名字应该都是由小写单词组成Class 的命名Class 的名字必须由大写字母开头而其他字母都小写的单词组成对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。 public class ThisAClassName{} 变量的命名 对于，所有单词都应紧靠在一起，而且大写中间单词的首字母。DB_CONFIG）。 参数的命名 参数的名字必须和变量的命名规范一致。数组的命名 数组方法的参数使用有意义的参数命名赋值的字段一样的名字 setSize(int size){ this.size = size; } 方法的命名 方法的命名遵循变量的命名，方法的名字必须用一个小写字母开头。后面的单词用大写字母开头注释规范 文字说明代码的作用（即为什么要用编写该代码，而不是如何编写）； 明确指出该代码的编写思路和逻辑方法； 使阅读者注意到代码中的重要转折点； 使阅读者不必在他们的头脑中仿真运行代码的执行方法。 何时书写注释：1）请在每个if语句的前面加上注释；2）在每个switch语句的前面加上注释。与if语句一样，switch语句用于评估对程序执行产生影响的表达式。 3）在每个循环的前面加上注释。每个循环都有它的作用，许多情况下这个作用不清楚直观。 Java的注释 单行注释：// 注释一行注释若干行 文档注释：注释若干行，并写入 javadoc 文档 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性注释要简单明了。package java.blah; import java.blah.blahdy.BlahBlah; /** * 对类的用途的描述. * * @version 1.82 1999-03-18 （版本信息，变更关键字），加上版本作者 1.82 1999-09-23 * @author Firstname Lastname（作者信息） */ public class MyClass extends SomeClass { /** 对公有成员变量的注释（单行的格式），建议采用单行的格式，节省版面*/ public int classVar1; /** * 对共有成员变量的注释（多行的格式） * more than one line long */ private Object classVar2; /** * ...对该方法用途的描述 * @param userName对参数userName的描述 * @param password 对参数password的描述 * @exception 对抛出异常的说明 * @return String 对返回值的描述 */ public String classMethod(String userName,String password) { // 对代码片断的注释（如，以下用于密码验证） if( flag == true){ //对代码逻辑块进行注释（如：如果密码验证通过） }else{ //对代码逻辑块进行注释（如：如果密码验证未通过） } } } JSP中注释 ＜%-- comment --%＞ JSP注释，也称为“隐藏注释”。JSP引擎将忽略它。标记内的所有JSP脚本元素、指令和动作都将不起作用。＜!-- comment --＞ HTML注释，也称为“输出的注释”，直接出现在结果HTML文档中。标记内的所有JSP脚本元素、指令和动作正常执行。代码编写格式缩进个空格缩进应该是每行个空格不要在源文件中保存Tab字符在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度页宽为80字符页宽应该设置为80字符源代码超过这个宽度导致无法完整显示但这一设置也可以灵活调整在任何情况下超长的语句应该在一个逗号或者一个操作符后折行一条语句折行后应该比原来的语句再缩进个字符username ＝ new String(); …… 而非以下形式： if( flag == true) flag == false; Stri