项目命名规范

Posted 逆水乘舟,不进则退

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了项目命名规范相关的知识,希望对你有一定的参考价值。

1 模块名称    比如计量模块写出JL

2注释 / *   */对方法进行注释或者对属性,有利于功能的扩展

3 包名 :每个包名都应该小写,例如:com.haiyisoft.store

4 类名 :TaskPlan 中间不允许出现下换线,并且首字母大写、

5  变量的命名 :writeSectno首字母小写并且符合命名驼峰命名法则

6  Static Final 变量的命名    

变量的名字应该都大写,并且指出完整含义。 变量的各个单词之间用下划线分隔

  Static final MAX_CONNECT_COUNT = 50;

7数组应该总是用下面的方式来命名:

byte[] buffer = new byte[10]; 

8  方法的命名:

方法的名字必须用一个小写字母(单词)开头。后面的单词用大写字母开头。 

get/set方法命名为get/set+首字母大写的成员变量名。

对返回boolean值的方法一般采用is开头,如isFile等.

所有的 Java(*.java) 文件都应遵守如下的样式规则:

/**  

 * 实现了....   

 *

 * @author      李四

*  

 * <p> Modification History:</p>

 * <p> Date         Author     Description </p>  

 * <p>------------------------------------------------------------------</p>  

 * <p>2010-11-12    李四       新建</p>

 * <p>2010-11-14    王五       修改了....</p>  

 */  

10 import 中标准的包名要在本地的包名之前。不需要的包不要引用

 

以上是关于项目命名规范的主要内容,如果未能解决你的问题,请参考以下文章

项目命名规范

Github库名命名规范

前端规范一(命名规范)

java命名规范

浅谈Android编码规范及命名规范

前端编码规范