第一次做技术总监制定的简单的java编码规范

院长

编码规范

目录

[url=]1. 排版规范[/url]

[url=]1.1 版权信息[/url]

[url=]1.2 Package/Imports[/url]

[url=]1.3 Class头部[/url]

[url=]1.4 成员变量[/url]

[url=]1.5 成员函数[/url]

[url=]2 命名规范[/url]

[url=]    2.1 Package 的命名[/url]

[url=]    2.2 Class 的命名[/url]

[url=]    2.3 Class 变量的命名[/url]

[url=]    2.4 Static Final 变量的命名[/url]

[url=]    2.5 参数的命名[/url]

[url=]    2.6 数组的命名[/url]

[url=]3 注释规范[/url]

[url=]1. 排版规范[/url]

l 相对独立的程序块与块之间加空行

l 关键词和操作符之间加适当的空格

l 较长的语句、表达式等要分成多行书写

l 划分出的新行要进行适应的缩进(一个Table位移4个空格)，使排版整齐，语句可读

l 若函数或过程中的参数较长，则要进行适当的划分

[url=]1.1 版权信息[/url]

  版权信息必须在 java 文件的开头

[url=]1.2 Package/Imports[/url]

package 行要在 import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。

[url=]1.3 Class头部[/url]

[url=]1.4 成员变量[/url]

      1.4.1 依据变量需要作用的作用域，合理的选择protected/private和public

     1.4.2 固定不变的常量使用 static final 关键字

[url=]1.5 成员函数[/url]

1.5.1 必要的函数写好注释

[url=]2 命名规范[/url]

l 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。

l 较短的单词可通过去掉“元音”形成缩写；

l 较长的单词可取单词的头几发符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。

l 使用匈牙利表示法

[url=] 2.1 Package 的命名[/url]

Package 的名字应该都是由一个小写单词组成。
package com.easygo.app.controller;

[url=] 2.2 Class 的命名[/url]

Class 的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。

public class ThisAClassName{}

[url=] 2.3 Class 变量的命名[/url]

变量的名字必须用一个小写字母开头。后面的单词用大写字母开头
   userName , thisAClassMethod

[url=] 2.4 Static Final 变量的命名[/url]

static final 变量的名字应该都大写，并且指出完整含义。

[url=]2.5 参数的命名[/url]

  参数的名字必须和变量的命名规范一致。

[url=]2.6 数组的命名[/url]

   数组应该总是用下面的方式来命名：
     byte[] buffer;
      而不是：
     byte buffer[];

[url=]3 注释规范[/url]

   3.1. 注释要简单明了。
        如：String userName = null; //用户名
    3.2. 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。

    3.3. 在必要的地方注释，注释量要适中。注释的内容要清楚、明了，含义准确，防止注释二义性。保持注释与其描述的代码相邻，即注释的就近原则。

    3.4. 对代码的注释应放在其上方相邻位置，不可放在下面。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释应放在此域的右方；同一结构中不同域的注释要对齐。

    3.5. 变量、常量的注释应放在其上方相邻位置或右方。

    3.6. 全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。

    3.7. 在每个函数或过程的前面要有必要的注释信息，包括：函数或过程名称；功能描述；输入、输出及返回值说明；调用关系及被调用关系说明等

3.8. javadoc 注释标签语法
        @author 对类的说明 标明开发该类模块的作者
        @version 对类的说明 标明该类模块的版本
        @see 对类、属性、方法的说明 参考转向，也就是相关主题
        @param 对方法的说明 对方法中某参数的说明
        @return 对方法的说明 对方法返回值的说明
        @exception 对方法的说明 对方法可能抛出的异常进行说明