精华内容
下载资源
问答
  • javaweb项目命名规范

    千次阅读 2014-03-27 00:38:50
    目的:包的命名规范应当体现出项目资源良好的划分 servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet 例如:net.linkcn.web.servlet 自定义标签类所在包命名规范:公司名称.开发组名

    代码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯。
    代码编写规范使用范围:J2EE项目开发。

    包命名规范:
    目的:包的命名规范应当体现出项目资源良好的划分

    servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet
    例如:net.linkcn.web.servlet

    自定义标签类所在包命名规范:公司名称.开发组名称.项目名称.web.tags
    例如:net.linkcn.web.tags

    过滤器类所在包命名规范:公司名称.开发组名称.项目名称.web.filter
    例如:net.linkcn.web.filter

    Action类所在包命名规范:公司名称.开发组名称.项目名称.web.struts.action
    例如:net.linkcn.web.struts.action

    ActionForm类所在包命名规范:公司名称.开发组名称.项目名称.web.struts.form
    例如:net.linkcn.web.struts.form

    Javabean所在包命名规范:公司名称.开发组名称.项目名称.web.struts.service.impl
    例如:net.linkcn.web.service.impl

    Javabean实现接口命名规范:公司名称.开发组名称.项目名称.web.service
    例如:net.linkcn.web.service

    DAO类所在包命名规范:公司名称.开发组名称.项目名称.dao.impl
    例如:net.linkcn.dao.impl

    DAO类所实现的接口在包中命名规范:公司名称.开发组名称.项目名称.dao
    例如:net.linkcn.dao

    POJO类与hbm文件所在包命名规范:公司名称.开发组名称.项目名称.dao.hbm
    例如:net.linkcn.dao.hbm

    全局公共类、接口类所在包命名规范:公司名称.开发组名称.项目名称.global
    例如:net.linkcn.global

    全局工具类所在包命名规范:公司名称.开发组名称.项目名称.util
    例如:net.linkcn.util

    类命名规范
    基本命名规范:

    类、接口命名
    命名规范:以大写字母开头,如果有多个单词,每个单词头字母大写
    例如:StudentInfo

    接口命名
    命名规范:以大写字母"I"开头,如果有多个单词,每个单词头字母大写
    例如:IStudentInfo

    接口实现类命名:
    命名规范:将实现的接口名称的首字母"I"去掉,以"Impl作为结尾",如果有多个单词,每个单词头字母大写。
    例如:StudentInfoImpl

    J2EE+SSH框架命名规范

    servlet类命名:
    命名规范:以Servlet单词结尾
    例如:LoginServlet

    POJO命名:
    使用hibernate自动生成的类即可

    DAO类命名:
    使用hibernate自动生成的类即可

    Action类命名:
    命名规范:Action的命名以POJO名称来制定,POJO名称Action
    例如:
    一个POJO名称为Diary,其对应的action为DiaryAction

    ActionForm类命名:
    命名规范:ActionForm的命名以POJO名称来制定,POJO名称Form
    例如:
    一个POJO名称为Diary,其对应的actioForm为DiaryForm

    业务逻辑接口命名:
    命名规范:业务逻辑接口的命名以POJO名称来制定,IPOJO名称Service
    例如:
    一个POJO名称为Diary,其对应的业务逻辑接口为IDiaryService

    业务逻辑实现类命名:
    命名规范:业务逻辑接口实现类的命名以POJO名称来制定
    例如:
    一个POJO名称为Diary,对应的业务逻辑接口实现类名为DiaryServiceImpl

    类变量命名:
    命名规范:变量名首字母必须小写,如果该变量名有多个单词组成,后面的单 词首字母大写,单词与单词之间不要使用"_"做连接,变量名访问控制必须为私有, 可以对其增加setter与getter方法。
    例如:

    private int studentAge;
    public int getStudentAge(){
    return studentAge;
    }
    public void setStudentAge(int studentAge) {
    this.studentAge=studentAge;
    }

    常量命名:
    命名规范:所有字母大写,如果有多个单词组成,单词与单词之间以” _“隔开。而 且该变量必须是公共、静态、final类型
    例如:public static final String USER_NAME=”userName“;

    方法命名
    命名规范:首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母 大写,单词与单词之间不要使用"_"做连接。单词不要使用名词。
    例如:public int checkLogin(String name,String pwd){}

    注释规范:注释规范是整个开发规范中最为重要的组成部分,必须严格执行。
    类的注释:
    作用:注释整个类,简单概述该类作用。
    书写规范:类的注释必须写在该类的声明语法之前。在注释中要描述该类的基 本作用,作者,日期,版本,公司名称,版权声明。
    格式:

    /* * 
    * 类功能描述:(大致描述类的功能) 
    * @author:编写者名称

    * @version: 类文件的版本号 从1.0开始(自己确定版本号的增改 
    * 情况), 修改情况(修改时间、作者、改动情况)
    *
    * @see 包名.参考类名 (列出父类,引入类,每个类占一行),如果有
    * 可省略 
    * 相关数据如:(便于理解本类的一些常量数据及某些数据的格式 
    * 或认为比较重要的数据,如果没有可省略) 
    */ 
    类的声明语法


    例如:

    /**
    * <p>Title:管理员模块数据处理类 </p>
    * <p>Description: 两个数相加</p>
    * <p>Copyright: Copyright (c) 2007</p>
    * <p>Company:华腾软件公司</p>

    * @author 童金虎

    * @version $Revision: 1.7 $ $Date: 2007/07/08$ 
    */
    public class AdminDAO

     

    变量、常量注释:
    作用:简单描述该变量的意义。
    书写规范:变量注释必须写在变量定义之前,简单描述其代表的意义。
    格式:

    /** 
    * 变量功能描述:(大致描述变量的功能)
    */


    例如:

    /**
    *定义年龄变量
    */
    public int age;

    方法注释:
    作用:对该方法功能简单描述,其参数、返回值意义的注解。
    书写规范:方法注释必须写在方法定义之前。该注释包括:方法其功能的简单 描述,方法的参数、返回值类型、返回值意义简单的描述。
    格式:

    /** 
    * 方法功能说明 
    * @param args (参数类型可以写在参数后,也可以省 
    * 略。每个参数占一行) 
    * @return 输出参数(多种情况写在同一行) 
    * @see 类#参考方法 (与此方法有调用关系的方法供参 
    * 考,不必每个方法都完整列出,要选择有意义的,每个 
    * 方法占一行) 
    * @exception 异常处理类(方法中能够引发的异常,每 
    * 个异常占一行) 
    */


    例如:

    /**
    * 修改管理员密码
    * @param adminId 管理员编号
    * @param oldPassword 旧密码
    * @param password 新密码
    * @return boolean 是否编辑成功
    * @throws UserException
    * @throws ServiceException
    */
    public booleaneditAdminPassword(int adminId,String oldPassword,
    String password) throws UserException,ServiceException;

    Jsp页面命名:
    命名规范:jsp页面名称要以小写字母开头,如果有多个单词组成,后面的单词以 大写字母开头。名称要体现出该页面的意义,最好能够与模块名称联系在一起。
    例如:
    login.jsp --登录页面
    register.jsp --注册页面
    message.jsp --客户留言页面

    J2EE项目工程文件夹组织规范:
    目的:规范学员web应用程序的资源组织形式,形成良好的文件组织习惯。文件的组织形式应当体现模块的划分。
    根据eclipse工具的特征,项目的目录结构为:

    src
    ----存放java文件 
    WebRoot
    |--images --存放web程序所需的公共图片
    |--css --存放web程序所需的公共样式表
    |--js --存放web程序所需的公共js文件
    |--commons --存放web程序所需的公共文件
    |--功能模块文件夹(存放与某个功能模块相关的资源)
    |--images --存放与该功能模块相关的图片
    |--css --存放与该模块相关的样式表文件
    |--js --存放与该模块相关的js文件
    |--jsp、html页面
    |--WEB-INF
    |--classes
    |--lib
    |--tld文件

    J2EE项目提交规范
    项目完成时要将项目作为一个产品交付用户,良好的项目组织规范可以使用户可以方便的找寻项目中需要的资源,同时也是一个公司专业性的体现。项目提交时,要按照下列文件格式进行提交。

    项目主文件夹:
    作用:存放项目其他资源文件。
    命名规范:时间_班级编号_第X小组。
    例如:070706_GS2T18_第四小组。

    项目主文件夹下面包括以下文件夹和文件:
    |--src:保存.java文件。
    |--database:保存数据库的脚本文件或者数据库备份文件。
    |--source:保存eclipse工程中WebRoot目录下的所有文件。
    |--depend:保存编译该程序必须依赖的其他jar文件。
    |--javadoc:保存所有类生成的javadoc api文档。
    |--war:保存程序的归档文件
    |--xx.war:已经打包好的工程文件,可以直接运行。
    |--project:保存开发项目原工程代码及文件。
    |--产品说明书.doc:图文方式展现该产品使用方法。
    |--build.xml:ant脚本,用于生成运行的war文件。
    |--项目解说.ppt:进行项目讲解的ppt(ppt仅供在校模拟项目使用,不用于其他商业用途)

    注:一个完整的项目中,数据库必须有一定量的有效的测试数据来支持该程序的运行

    包的命名 

    Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性,每一名Java程序员都可以编写属于自己的Java包,为了保障每个 Java包命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的,所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。 
    例如: net.frontfree.javagroup

    类的命名

    类的名字必须由大写字母开头而单词中的其他字母均为小写;如果类名称由多个单词组成,则每个单词的首字母均应为大写例如TestPage;如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的,所以在命名类时应尽量选择名词。    
    例如: Circle

    方法的命名

    方法的名字的第一个单词应以小写字母作为开头,后面的单词则用大写字母开头。 
    例如: sendMessge

    常量的命名

    常量的名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线来分割这些单词。 
    例如: MAX_VALUE

    参数的命名

    参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。

    Javadoc注释

    Java除了可以采用我们常见的注释方式之外,Java语言规范还定义了一种特殊的注释,也就是我们所说的Javadoc注释,它是用来记录我们代码中的API的。Javadoc注释是一种多行注释,以/**开头,而以*/结束,注释可以包含一些HTML标记符和专门的关键词。使用Javadoc 注释的好处是编写的注释可以被自动转为在线文档,省去了单独编写程序文档的麻烦。 
    例如:

    /** 
    * This is an example of 
    * Javadoc 

    * @author darchon 
    * @version 0.1, 10/11/2002 
    */

    在每个程序的最开始部分,一般都用Javadoc注释对程序的总体描述以及版权信息,之后在主程序中可以为每个类、接口、方法、字段添加 Javadoc注释,每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能,这句话应单独占据一行以突出其概括作用,在这句话后面可以跟随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落,例如上面例子中的@auther和@version,这些段落将在生成文档中以特定方式显示。


    变量和常量命名

    变量命名的方法采用匈牙利命名法,基本结构为scope_typeVariableName,它使用3字符前缀来表示数据类型,3个字符的前缀必须小写,前缀后面是由表意性强的一个单词或多个单词组成的名字,而且每个单词的首写字母大写,其它字母小写,这样保证了对变量名能够进行正确的断句。例如,定义一个整形变量,用来记录文档数量:intDocCount,其中int表明数据类型,后面为表意的英文名,每个单词首字母大写。这样,在一个变量名就可以反映出变量类型和变量所存储的值的意义两方面内容,这使得代码语句可读性强、更加容易理解。byte、int、char、long、float、 double、boolean和short。

    变量类型和首字母对照关系如下表:

    数据类型/对象类型 / 变量前缀 / 备注

    byte bye 
    char chr 
    float flt 
    boolean bln 做布尔变量时,使用bln 
    Integer/int int 
    String str 
    Single sng 
    short sht 
    Long/long lng 
    Double/double dbl 
    Currency cur 
    Variant bln astr obj vnt 做布尔变量用时,用bln,做字符串数组用时,用astr,做为对象使用时,用obj,不确定时,用vnt。

    对于数组,在数据类型的前缀前再增加一个a,例如字符串数组为astr。对于在多个函数内都要使用的全局变量,在前面再增加“g_”。例如一个全局的字符串变量:g_strUserInfo。

    在变量命名时要注意以下几点:

    · 选择有意义的名字,注意每个单词首字母要大写。

    · 在一段函数中不使用同一个变量表示前后意义不同的两个数值。

    · i、j、k等只作为小型循环的循环索引变量。

    · 避免用Flag来命名状态变量。

    · 用Is来命名逻辑变量,如:blnFileIsFound。通过这种给布尔变量肯定形式的命名方式,使得其它开发人员能够更为清楚的理解布尔变量所代表的意义。

    · 如果需要的话,在变量最后附加计算限定词,如:curSalesSum。

    · 命名不相包含,curSales和curSalesSum。

    · Static Final 变量的名字应该都大写,并且指出完整含义。

    · 如果需要对变量名进行缩写时,一定要注意整个代码中缩写规则的一致性。例如,如果在代码的某些区域中使用intCnt,而在另一些区域中又使用intCount,就会给代码增加不必要的复杂性。建议变量名中尽量不要出现缩写。

    · 通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。例如,请使用 strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。常用的量词后缀有:First(一组变量中的第一个)、Last(一组变量中的最后一个)、Next(一组变量中的下一个变量)、Prev(一组变量中的上一个)、Cur(一组变量中的当前变量)。

    · 为每个变量选择最佳的数据类型,这样即能减少对内存的需求量,加快代码的执行速度,又会降低出错的可能性。用于变量的数据类型可能会影响该变量进行计算所产生的结果。在这种情况下,编译器不会产生运行期错误,它只是迫使该值符合数据类型的要求。这类问题极难查找。

    · 尽量缩小变量的作用域。如果变量的作用域大于它应有的范围,变量可继续存在,并且在不再需要该变量后的很长时间内仍然占用资源。它们的主要问题是,任何类中的任何方法都能对它们进行修改,并且很难跟踪究竟是何处进行修改的。占用资源是作用域涉及的一个重要问题。对变量来说,尽量缩小作用域将会对应用程序的可靠性产生巨大的影响。

    关于常量的命名方法,在JAVA代码中,无论什么时候,均提倡应用常量取代数字、固定字符串。也就是说,程序中除0,1以外,尽量不应该出现其他数字。常量可以集中在程序开始部分定义或者更宽的作用域内,名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线“_”来分割这些单词如:NUM_DAYS_IN_WEEK、MAX_VALUE。

    展开全文
  • JavaEE项目命名规范

    千次阅读 2013-05-28 20:37:56
    代码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的...目的:包的命名规范应当体现出项目资源良好的划分 servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet

    本文来源:http://blog.csdn.net/lin_yongrui


    代码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯。
    代码编写规范使用范围:J2EE项目开发。


    包命名规范:
    目的:包的命名规范应当体现出项目资源良好的划分

    servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet
    例如:net.linkcn.web.servlet

    自定义标签类所在包命名规范:公司名称.开发组名称.项目名称.web.tags
    例如:net.linkcn.web.tags

    过滤器类所在包命名规范:公司名称.开发组名称.项目名称.web.filter
    例如:net.linkcn.web.filter

    Action类所在包命名规范:公司名称.开发组名称.项目名称.web.struts.action
    例如:net.linkcn.web.struts.action

    ActionForm类所在包命名规范:公司名称.开发组名称.项目名称.web.struts.form
    例如:net.linkcn.web.struts.form

    Javabean所在包命名规范:公司名称.开发组名称.项目名称.web.struts.service.impl
    例如:net.linkcn.web.service.impl

    Javabean实现接口命名规范:公司名称.开发组名称.项目名称.web.service
    例如:net.linkcn.web.service

    DAO类所在包命名规范:公司名称.开发组名称.项目名称.dao.impl
    例如:net.linkcn.dao.impl

    DAO类所实现的接口在包中命名规范:公司名称.开发组名称.项目名称.dao
    例如:net.linkcn.dao

    POJO类与hbm文件所在包命名规范:公司名称.开发组名称.项目名称.dao.hbm
    例如:net.linkcn.dao.hbm

    全局公共类、接口类所在包命名规范:公司名称.开发组名称.项目名称.global
    例如:net.linkcn.global

    全局工具类所在包命名规范:公司名称.开发组名称.项目名称.util
    例如:net.linkcn.util


    类命名规范

    类、接口命名
    命名规范:以大写字母开头,如果有多个单词,每个单词头字母大写
    例如:StudentInfo

    接口命名
    命名规范:以大写字母"I"开头,如果有多个单词,每个单词头字母大写
    例如:IStudentInfo

    接口实现类命名:
    命名规范:将实现的接口名称的首字母"I"去掉,以"Impl作为结尾",如果有多个单词,每个单词头字母大写。
    例如:StudentInfoImpl

    J2EE+SSH框架命名规范

    servlet类命名:
    命名规范:以Servlet单词结尾
    例如:LoginServlet

    POJO命名:
    使用hibernate自动生成的类即可

    DAO类命名:
    使用hibernate自动生成的类即可

    Action类命名:
    命名规范:Action的命名以POJO名称来制定,POJO名称Action
    例如:
    一个POJO名称为Diary,其对应的action为DiaryAction

    ActionForm类命名:
    命名规范:ActionForm的命名以POJO名称来制定,POJO名称Form
    例如:
    一个POJO名称为Diary,其对应的actioForm为DiaryForm

    业务逻辑接口命名:
    命名规范:业务逻辑接口的命名以POJO名称来制定,IPOJO名称Service
    例如:
    一个POJO名称为Diary,其对应的业务逻辑接口为IDiaryService

    业务逻辑实现类命名:
    命名规范:业务逻辑接口实现类的命名以POJO名称来制定
    例如:
    一个POJO名称为Diary,对应的业务逻辑接口实现类名为DiaryServiceImpl


    类变量命名:
    命名规范:变量名首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母大写,单词与单词之间不要使用"_"做连接,变量名访问控制必须为私有, 可以对其增加setter与getter方法。
    例如:

    private int studentAge;
    public int getStudentAge(){
        returnstudentAge;
    }
    public void setStudentAge(int studentAge) {
       this.studentAge=studentAge;
    }


    常量命名:
    命名规范:所有字母大写,如果有多个单词组成,单词与单词之间以” _“隔开。而 且该变量必须是公共、静态、final类型
    例如:public static final String USER_NAME=”userName“;


    方法命名
    命名规范:首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母 大写,单词与单词之间不要使用"_"做连接。单词不要使用名词。
    例如:public int checkLogin(String name,String pwd){}


    注释规范:注释规范是整个开发规范中最为重要的组成部分,必须严格执行。
    1、类的注释:
    作用:注释整个类,简单概述该类作用。
    书写规范:类的注释必须写在该类的声明语法之前。在注释中要描述该类的基 本作用,作者,日期,版本,公司名称,版权声明。
    格式:


    类的声明语法
    例如:


    public class AdminDAO


    2、变量、常量注释:
    作用:简单描述该变量的意义。
    书写规范:变量注释必须写在变量定义之前,简单描述其代表的意义。
    格式:


    例如:

    public int age;

    3、方法注释:
    作用:对该方法功能简单描述,其参数、返回值意义的注解。
    书写规范:方法注释必须写在方法定义之前。该注释包括:方法其功能的简单 描述,方法的参数、返回值类型、返回值意义简单的描述。
    格式:


    例如:


    public booleaneditAdminPassword(int adminId,StringoldPassword,
    String password) throws UserException,ServiceException;


    Jsp页面命名:
    命名规范:jsp页面名称要以小写字母开头,如果有多个单词组成,后面的单词以 大写字母开头。名称要体现出该页面的意义,最好能够与模块名称联系在一起。
    例如:
    login.jsp  --登录页面
    register.jsp   --注册页面
    message.jsp  --客户留言页面

    J2EE项目工程文件夹组织规范:
    目的:规范学员web应用程序的资源组织形式,形成良好的文件组织习惯。文件的组织形式应当体现模块的划分。
    根据eclipse工具的特征,项目的目录结构为:

    src
             ----存放java文件 
    WebRoot
    |--images    --存放web程序所需的公共图片
    |--css        --存放web程序所需的公共样式表
    |--js   --存放web程序所需的公共js文件
    |--commons  --存放web程序所需的公共文件
    |--功能模块文件夹(存放与某个功能模块相关的资源)
    |--images  --存放与该功能模块相关的图片
    |--css     --存放与该模块相关的样式表文件
    |--js   --存放与该模块相关的js文件
    |--jsp、html页面
    |--WEB-INF
    |--classes
    |--lib
    |--tld文件


    J2EE项目提交规范
    项目完成时要将项目作为一个产品交付用户,良好的项目组织规范可以使用户可以方便的找寻项目中需要的资源,同时也是一个公司专业性的体现。项目提交时,要按照下列文件格式进行提交。

    项目主文件夹:
    作用:存放项目其他资源文件。
    命名规范:时间_班级编号_第X小组。
    例如:070706_GS2T18_第四小组。

    项目主文件夹下面包括以下文件夹和文件:
    |--src:保存.java文件。
    |--database:保存数据库的脚本文件或者数据库备份文件。
    |--source:保存eclipse工程中WebRoot目录下的所有文件。
    |--depend:保存编译该程序必须依赖的其他jar文件。
    |--javadoc:保存所有类生成的javadoc api文档。
    |--war:保存程序的归档文件
    |--xx.war:已经打包好的工程文件,可以直接运行。
    |--project:保存开发项目原工程代码及文件。
    |--产品说明书.doc:图文方式展现该产品使用方法。
    |--build.xml:ant脚本,用于生成运行的war文件。
    |--项目解说.ppt:进行项目讲解的ppt(ppt仅供在校模拟项目使用,不用于其他商业用途)

    注:一个完整的项目中,数据库必须有一定量的有效的测试数据来支持该程序的运行



     

    包的命名

    Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性,每一名Java程序员都可以编写属于自己的Java包,为了保障每个Java包命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的,所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。    
    例如:   net.frontfree.javagroup    

    类的命名    

    类的名字必须由大写字母开头而单词中的其他字母均为小写;如果类名称由多个单词组成,则每个单词的首字母均应为大写例如TestPage;如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的,所以在命名类时应尽量选择名词。       
    例如:   Circle    

    方法的命名    

    方法的名字的第一个单词应以小写字母作为开头,后面的单词则用大写字母开头。  
    例如:   sendMessge    

    常量的命名  

    常量的名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线来分割这些单词。  
    例如:   MAX_VALUE  

    参数的命名  

    参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。  

    Javadoc注释  

    Java除了可以采用我们常见的注释方式之外,Java语言规范还定义了一种特殊的注释,也就是我们所说的Javadoc注释,它是用来记录我们代码中的API的。Javadoc注释是一种多行注释,以结束,注释可以包含一些HTML标记符和专门的关键词。使用Javadoc注释的好处是编写的注释可以被自动转为在线文档,省去了单独编写程序文档的麻烦。  
    例如:    

      

    在每个程序的最开始部分,一般都用Javadoc注释对程序的总体描述以及版权信息,之后在主程序中可以为每个类、接口、方法、字段添加Javadoc注释,每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能,这句话应单独占据一行以突出其概括作用,在这句话后面可以跟随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落,例如上面例子中的@auther和@version,这些段落将在生成文档中以特定方式显示。


    变量和常量命名

    变量命名的方法采用匈牙利命名法,基本结构为scope_typeVariableName,它使用3字符前缀来表示数据类型,3个字符的前缀必须小写,前缀后面是由表意性强的一个单词或多个单词组成的名字,而且每个单词的首写字母大写,其它字母小写,这样保证了对变量名能够进行正确的断句。例如,定义一个整形变量,用来记录文档数量:intDocCount,其中int表明数据类型,后面为表意的英文名,每个单词首字母大写。这样,在一个变量名就可以反映出变量类型和变量所存储的值的意义两方面内容,这使得代码语句可读性强、更加容易理解。byte、int、char、long、float、double、boolean和short。  

    变量类型和首字母对照关系如下表:

    数据类型/对象类型 / 变量前缀 / 备注  

    byte bye  
    char chr  
    float flt  
    boolean bln 做布尔变量时,使用bln  
    Integer/intint    
    String str  
    Single sng  
    short sht  
    Long/long lng  
    Double/double dbl  
    Currency cur  
    Variantbln     astr     obj     vnt 做布尔变量用时,用bln,做字符串数组用时,用astr,做为对象使用时,用obj,不确定时,用vnt。

    对于数组,在数据类型的前缀前再增加一个a,例如字符串数组为astr。对于在多个函数内都要使用的全局变量,在前面再增加“g_”。例如一个全局的字符串变量:g_strUserInfo。
      
    在变量命名时要注意以下几点:

    · 选择有意义的名字,注意每个单词首字母要大写。
      
    · 在一段函数中不使用同一个变量表示前后意义不同的两个数值。
      
    · i、j、k等只作为小型循环的循环索引变量。  

    · 避免用Flag来命名状态变量。  

    ·用Is来命名逻辑变量,如:blnFileIsFound。通过这种给布尔变量肯定形式的命名方式,使得其它开发人员能够更为清楚的理解布尔变量所代表的意义。  

    ·如果需要的话,在变量最后附加计算限定词,如:curSalesSum。  

    · 命名不相包含,curSales和curSalesSum。

    · Static   Final   变量的名字应该都大写,并且指出完整含义。  

    ·如果需要对变量名进行缩写时,一定要注意整个代码中缩写规则的一致性。例如,如果在代码的某些区域中使用intCnt,而在另一些区域中又使用intCount,就会给代码增加不必要的复杂性。建议变量名中尽量不要出现缩写。  

    · 通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。例如,请使用strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。常用的量词后缀有:First(一组变量中的第一个)、Last(一组变量中的最后一个)、Next(一组变量中的下一个变量)、Prev(一组变量中的上一个)、Cur(一组变量中的当前变量)。

    ·为每个变量选择最佳的数据类型,这样即能减少对内存的需求量,加快代码的执行速度,又会降低出错的可能性。用于变量的数据类型可能会影响该变量进行计算所产生的结果。在这种情况下,编译器不会产生运行期错误,它只是迫使该值符合数据类型的要求。这类问题极难查找。

    ·尽量缩小变量的作用域。如果变量的作用域大于它应有的范围,变量可继续存在,并且在不再需要该变量后的很长时间内仍然占用资源。它们的主要问题是,任何类中的任何方法都能对它们进行修改,并且很难跟踪究竟是何处进行修改的。占用资源是作用域涉及的一个重要问题。对变量来说,尽量缩小作用域将会对应用程序的可靠性产生巨大的影响。  

    关于常量的命名方法,在JAVA代码中,无论什么时候,均提倡应用常量取代数字、固定字符串。也就是说,程序中除0,1以外,尽量不应该出现其他数字。常量可以集中在程序开始部分定义或者更宽的作用域内,名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线“_”来分割这些单词如:NUM_DAYS_IN_WEEK、MAX_VALUE。

    展开全文
  • 项目的一些命名规范

    千次阅读 2018-07-10 09:19:55
    命名规范:目的:包的命名规范应当体现出项目资源良好的划分 servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet例如:net.linkcn.web.servlet 自定义标签类所在包命名规范:公司名...

    代码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯。
    代码编写规范使用范围:J2EE项目开发。
    包命名规范:
    目的:包的命名规范应当体现出项目资源良好的划分

    servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet
    例如:net.linkcn.web.servlet

    自定义标签类所在包命名规范:公司名称.开发组名称.项目名称.web.tags
    例如:net.linkcn.web.tags

    过滤器类所在包命名规范:公司名称.开发组名称.项目名称.web.filter
    例如:net.linkcn.web.filter

    Action类所在包命名规范:公司名称.开发组名称.项目名称.web.struts.action
    例如:net.linkcn.web.struts.action

    ActionForm类所在包命名规范:公司名称.开发组名称.项目名称.web.struts.form
    例如:net.linkcn.web.struts.form

    Javabean所在包命名规范:公司名称.开发组名称.项目名称.web.struts.service.impl
    例如:net.linkcn.web.service.impl

    Javabean实现接口命名规范:公司名称.开发组名称.项目名称.web.service
    例如:net.linkcn.web.service

    DAO类所在包命名规范:公司名称.开发组名称.项目名称.dao.impl
    例如:net.linkcn.dao.impl

    DAO类所实现的接口在包中命名规范:公司名称.开发组名称.项目名称.dao
    例如:net.linkcn.dao

    POJO类与hbm文件所在包命名规范:公司名称.开发组名称.项目名称.dao.hbm
    例如:net.linkcn.dao.hbm

    全局公共类、接口类所在包命名规范:公司名称.开发组名称.项目名称.global
    例如:net.linkcn.global

    全局工具类所在包命名规范:公司名称.开发组名称.项目名称.util
    例如:net.linkcn.util

    类命名规范
    基本命名规范:

    类、接口命名

    命名规范:以大写字母开头,如果有多个单词,每个单词头字母大写
    例如:StudentInfo
    接口命名

    命名规范:以大写字母"I"开头,如果有多个单词,每个单词头字母大写
    例如:IStudentInfo

    接口实现类命名:
    命名规范:将实现的接口名称的首字母"I"去掉,以"Impl作为结尾",如果有多个单词,每个单词头字母大写。
    例如:StudentInfoImpl

    J2EE+SSH框架命名规范
    servlet类命名:
    命名规范:以Servlet单词结尾
    例如:LoginServlet

    POJO命名:
    使用hibernate自动生成的类即可

    DAO类命名:
    使用hibernate自动生成的类即可

    Action类命名:
    命名规范:Action的命名以POJO名称来制定,POJO名称Action
    例如:
    一个POJO名称为Diary,其对应的action为DiaryAction

    ActionForm类命名:
    命名规范:ActionForm的命名以POJO名称来制定,POJO名称Form
    例如:
    一个POJO名称为Diary,其对应的actioForm为DiaryForm

    业务逻辑接口命名:
    命名规范:业务逻辑接口的命名以POJO名称来制定,IPOJO名称Service
    例如:
    一个POJO名称为Diary,其对应的业务逻辑接口为IDiaryService

    业务逻辑实现类命名:
    命名规范:业务逻辑接口实现类的命名以POJO名称来制定
    例如:
    一个POJO名称为Diary,对应的业务逻辑接口实现类名为DiaryServiceImpl

    类变量命名:
    命名规范:变量名首字母必须小写,如果该变量名有多个单词组成,后面的单 词首字母大写,单词与单词之间不要使用"_"做连接,变量名访问控制必须为私有, 可以对其增加setter与getter方法。
    例如:
    private int studentAge;
    public int getStudentAge(){
    return studentAge;
    }
    public void setStudentAge(int studentAge) {
    this.studentAge=studentAge;
    }

    常量命名:
    命名规范:所有字母大写,如果有多个单词组成,单词与单词之间以” _“隔开。而 且该变量必须是公共、静态、final类型
    例如:public static final String USER_NAME=”userName“;

    方法命名
    命名规范:首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母 大写,单词与单词之间不要使用"_"做连接。单词不要使用名词。
    例如:public int checkLogin(String name,String pwd){}

    注释规范:注释规范是整个开发规范中最为重要的组成部分,必须严格执行。

    类的注释:
    作用:注释整个类,简单概述该类作用。
    书写规范:类的注释必须写在该类的声明语法之前。在注释中要描述该类的基 本作用,作者,日期,版本,公司名称,版权声明。
    格式:

    类的声明语法

    例如:

    public class AdminDAO

    变量、常量注释:
    作用:简单描述该变量的意义。
    书写规范:变量注释必须写在变量定义之前,简单描述其代表的意义。
    格式:

    例如:

    public int age;
    方法注释:
    作用:对该方法功能简单描述,其参数、返回值意义的注解。
    书写规范:方法注释必须写在方法定义之前。该注释包括:方法其功能的简单 描述,方法的参数、返回值类型、返回值意义简单的描述。
    格式:

    例如:

    public booleaneditAdminPassword(int adminId,String oldPassword,
    String password) throws UserException,ServiceException;

    Jsp页面命名:
    命名规范:jsp页面名称要以小写字母开头,如果有多个单词组成,后面的单词以 大写字母开头。名称要体现出该页面的意义,最好能够与模块名称联系在一起。
    例如:
    login.jsp --登录页面
    register.jsp --注册页面
    message.jsp --客户留言页面

    J2EE项目工程文件夹组织规范:
    目的:规范学员web应用程序的资源组织形式,形成良好的文件组织习惯。文件的组织形式应当体现模块的划分。

    根据eclipse工具的特征,项目的目录结构为:
    src
    ----存放java文件
    WebRoot
    |--images --存放web程序所需的公共图片
    |--css --存放web程序所需的公共样式表
    |--js --存放web程序所需的公共js文件
    |--commons --存放web程序所需的公共文件
    |--功能模块文件夹(存放与某个功能模块相关的资源)
    |--images --存放与该功能模块相关的图片
    |--css --存放与该模块相关的样式表文件
    |--js --存放与该模块相关的js文件
    |--jsp、html页面
    |--WEB-INF
    |--classes
    |--lib
    |--tld文件

    J2EE项目提交规范
    项目完成时要将项目作为一个产品交付用户,良好的项目组织规范可以使用户可以方便的找寻项目中需要的资源,同时也是一个公司专业性的体现。项目提交时,要按照下列文件格式进行提交。

    项目主文件夹:
    作用:存放项目其他资源文件。
    命名规范:时间_班级编号_第X小组。
    例如:070706_GS2T18_第四小组。
    项目主文件夹下面包括以下文件夹和文件:
    |--src:保存.java文件。
    |--database:保存数据库的脚本文件或者数据库备份文件。
    |--source:保存eclipse工程中WebRoot目录下的所有文件。
    |--depend:保存编译该程序必须依赖的其他jar文件。
    |--javadoc:保存所有类生成的javadoc api文档。
    |--war:保存程序的归档文件
    |--xx.war:已经打包好的工程文件,可以直接运行。
    |--project:保存开发项目原工程代码及文件。
    |--产品说明书.doc:图文方式展现该产品使用方法。
    |--build.xml:ant脚本,用于生成运行的war文件。
    |--项目解说.ppt:进行项目讲解的ppt(ppt仅供在校模拟项目使用,不用于其他商业用途)
    注:一个完整的项目中,数据库必须有一定量的有效的测试数据来支持该程序的运行

    包的命名 
    Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性,每一名Java程序员都可以编写属于自己的Java包,为了保障每个 Java包命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的,所以程序 员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。
    例如: net.frontfree.javagroup

    类的命名
    类的名字必须由大写字母开头而单词中的其他字母均为小写;如果类名称由多个单词组成,则每个单词的首字母均应为大写例如TestPage;如果类名 称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的,所以在命名类时应尽量 选择名词。   
    例如: Circle

    方法的命名
    方法的名字的第一个单词应以小写字母作为开头,后面的单词则用大写字母开头。
    例如: sendMessge

    常量的命名
    常量的名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线来分割这些单词。
    例如: MAX_VALUE

    参数的命名
    参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。

    Javadoc注释
    Java除了可以采用我们常见的注释方式之外,Java语言规范还定义了一种特殊的注释,也就是我们所说的Javadoc注释,它是用来记录我们代 码中的API的。Javadoc注释是一种多行注释,以结束,注释可以包含一些HTML标记符和专门的关键词。使用Javadoc 注释的好处是编写的注释可以被自动转为在线文档,省去了单独编写程序文档的麻烦。
    例如:

    在每个程序的最开始部分,一般都用Javadoc注释对程序的总体描述以及版权信息,之后在主程序中可以为每个类、接口、方法、字段添加 Javadoc注释,每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能,这句话应单独占据一行以突出其概括作用,在这句话后面可以跟 随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落,例如上面例子中的@auther和@version,这 些段落将在生成文档中以特定方式显示。

    变量和常量命名
    变量命名的方法采用匈牙利命名法,基本结构为scope_typeVariableName,它使用3字符前缀来表示数据类型,3个字符的前缀必须 小写,前缀后面是由表意性强的一个单词或多个单词组成的名字,而且每个单词的首写字母大写,其它字母小写,这样保证了对变量名能够进行正确的断句。例如, 定义一个整形变量,用来记录文档数量:intDocCount,其中int表明数据类型,后面为表意的英文名,每个单词首字母大写。这样,在一个变量名就 可以反映出变量类型和变量所存储的值的意义两方面内容,这使得代码语句可读性强、更加容易理解。byte、int、char、long、float、 double、boolean和short。
    变量类型和首字母对照关系如下表:
    数据类型/对象类型 / 变量前缀 / 备注
    byte bye
    char chr
    float flt
    boolean bln 做布尔变量时,使用bln
    Integer/int int
    String str
    Single sng
    short sht
    Long/long lng
    Double/double dbl
    Currency cur
    Variant bln astr obj vnt 做布尔变量用时,用bln,做字符串数组用时,用astr,做为对象使用时,用obj,不确定时,用vnt。
    对于数组,在数据类型的前缀前再增加一个a,例如字符串数组为astr。对于在多个函数内都要使用的全局变量,在前面再增加“g_”。例如一个全局的字符串变量:g_strUserInfo。

    在变量命名时要注意以下几点:
    · 选择有意义的名字,注意每个单词首字母要大写。

    · 在一段函数中不使用同一个变量表示前后意义不同的两个数值。

    · i、j、k等只作为小型循环的循环索引变量。

    · 避免用Flag来命名状态变量。

    · 用Is来命名逻辑变量,如:blnFileIsFound。通过这种给布尔变量肯定形式的命名方式,使得其它开发人员能够更为清楚
    的理解布尔变量所代表的意义。

    · 如果需要的话,在变量最后附加计算限定词,如:curSalesSum。

    · 命名不相包含,curSales和curSalesSum。

    · Static Final 变量的名字应该都大写,并且指出完整含义。

    · 如果需要对变量名进行缩写时,一定要注意整个代码中缩写规则的一致性。例如,如果在代码的某些区域中使用intCnt,而在另一些区域中又使用intCount,就会给代码增加不必要的复杂性。建议变量名中尽量不要出现缩写。

    · 通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。例如,请使用 strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。常 用的量词后缀有:First(一组变量中的第一个)、Last(一组变量中的最后一个)、Next(一组变量中的下一个变量)、Prev(一组变量中的上 一个)、Cur(一组变量中的当前变量)。

    · 为每个变量选择最佳的数据类型,这样即能减少对内存的需求量,加快代码的执行速度,又会降低出错的可能性。用于变量的数据类型可能会影响该变量进行计算所产生的结果。在这种情况下,编译器不会产生运行期错误,它只是迫使该值符合数据类型的要求。这类问题极难查找。

    · 尽量缩小变量的作用域。如果变量的作用域大于它应有的范围,变量可继续存在,并且在不再需要该变量后的很长时间内仍然占用资源。它们的主要问题是,任何类 中的任何方法都能对它们进行修改,并且很难跟踪究竟是何处进行修改的。占用资源是作用域涉及的一个重要问题。对变量来说,尽量缩小作用域将会对应用程序的 可靠性产生巨大的影响。
    关于常量的命名方法,在JAVA代码中,无论什么时候,均提倡应用常量取代数字、固定字符串。也就是说,程序中除0,1以外,尽量不应该出现其他数 字。常量可以集中在程序开始部分定义或者更宽的作用域内,名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下 划线“_”来分割这些单词如:NUM_DAYS_IN_WEEK、MAX_VALUE。

    展开全文
  • 一、包命名规范:目的:包的命名规范应当体现出项目资源良好的划分 1.servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet 例如:net.linkcn.web.servlet 2.自定义标签类所在包命名规范:公司名称...

    代码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯。


    代码编写规范使用范围:J2EE项目开发。


    一、包命名规范:
    目的:包的命名规范应当体现出项目资源良好的划分

    1.servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet
    例如:net.linkcn.web.servlet


    2.自定义标签类所在包命名规范:公司名称.开发组名称.项目名称.web.tags
    例如:net.linkcn.web.tags


    3.过滤器类所在包命名规范:公司名称.开发组名称.项目名称.web.filter
    例如:net.linkcn.web.filter


    4.Action类所在包命名规范:公司名称.开发组名称.项目名称.web.struts.action
    例如:net.linkcn.web.struts.action


    5.ActionForm类所在包命名规范:公司名称.开发组名称.项目名称.web.struts.form
    例如:net.linkcn.web.struts.form


    6.Javabean所在包命名规范:公司名称.开发组名称.项目名称.web.struts.service.impl
    例如:net.linkcn.web.service.impl


    7.Javabean实现接口命名规范:公司名称.开发组名称.项目名称.web.service
    例如:net.linkcn.web.service


    8.DAO类所在包命名规范:公司名称.开发组名称.项目名称.dao.impl
    例如:net.linkcn.dao.impl


    9.DAO类所实现的接口在包中命名规范:公司名称.开发组名称.项目名称.dao
    例如:net.linkcn.dao


    10.POJO类与hbm文件所在包命名规范:公司名称.开发组名称.项目名称.dao.hbm
    例如:net.linkcn.dao.hbm


    11.全局公共类、接口类所在包命名规范:公司名称.开发组名称.项目名称.global
    例如:net.linkcn.global


    12.全局工具类所在包命名规范:公司名称.开发组名称.项目名称.util
    例如:net.linkcn.util

     


    二、类命名规范
    基本命名规范:

    1.类、接口命名
    命名规范:以大写字母开头,如果有多个单词,每个单词头字母大写
    例如:StudentInfo

     

    2.接口命名

    命名规范:以大写字母"I"开头,如果有多个单词,每个单词头字母大写
    例如:IStudentInfo

    3.接口实现类命名:
    命名规范:将实现的接口名称的首字母"I"去掉,以"Impl作为结尾",如果有多个单词,每个单词头字母大写。
    例如:StudentInfoImpl

    4.J2EE+SSH框架命名规范
    servlet类命名:
    命名规范:以Servlet单词结尾
    例如:LoginServlet

    5.POJO命名:
    使用hibernate自动生成的类即可

    6.DAO类命名:
    使用hibernate自动生成的类即可

    7.Action类命名:
    命名规范:Action的命名以POJO名称来制定,POJO名称Action
    例如:
    一个POJO名称为Diary,其对应的action为DiaryAction

    8.ActionForm类命名:
    命名规范:ActionForm的命名以POJO名称来制定,POJO名称Form
    例如:
    一个POJO名称为Diary,其对应的actioForm为DiaryForm

    9.业务逻辑接口命名:
    命名规范:业务逻辑接口的命名以POJO名称来制定,IPOJO名称Service
    例如:
    一个POJO名称为Diary,其对应的业务逻辑接口为IDiaryService

    10.业务逻辑实现类命名:
    命名规范:业务逻辑接口实现类的命名以POJO名称来制定
    例如:
    一个POJO名称为Diary,对应的业务逻辑接口实现类名为DiaryServiceImpl

    11.类变量命名:
    命名规范:变量名首字母必须小写,如果该变量名有多个单词组成,后面的单 词首字母大写,单词与单词之间不要使用"_"做连接,变量名访问控制必须为私有, 可以对其增加setter与getter方法。
    例如:
    private int studentAge;
    public int getStudentAge(){
    return studentAge;
    }
    public void setStudentAge(int studentAge) {
    this.studentAge=studentAge;
    }

    12.常量命名:
    命名规范:所有字母大写,如果有多个单词组成,单词与单词之间以” _“隔开。而 且该变量必须是公共、静态、final类型
    例如:public static final String USER_NAME=”userName“;

    13.方法命名
    命名规范:首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母 大写,单词与单词之间不要使用"_"做连接。单词不要使用名词。
    例如:public int checkLogin(String name,String pwd){}

    14.注释规范:

    注释规范是整个开发规范中最为重要的组成部分,必须严格执行。

    15.类的注释:
    作用:注释整个类,简单概述该类作用。
    书写规范:类的注释必须写在该类的声明语法之前。

    在注释中要描述该类的基 本作用,作者,日期,版本,公司名称,版权声明。
    格式:

    16.类的声明语法

    例如:public class AdminDAO

    17.变量、常量注释:
    作用:简单描述该变量的意义。
    书写规范:变量注释必须写在变量定义之前,简单描述其代表的意义。
    格式:
    例如:
    public int age;

    18.方法注释:
    作用:对该方法功能简单描述,其参数、返回值意义的注解。
    书写规范:方法注释必须写在方法定义之前。该注释包括:方法其功能的简单 描述,方法的参数、返回值类型、返回值意义简单的描述。
    格式:
    例如:
    public booleaneditAdminPassword(int adminId,String oldPassword,
    String password) throws UserException,ServiceException;

    三、Jsp页面命名:
    命名规范:jsp页面名称要以小写字母开头,如果有多个单词组成,后面的单词以 大写字母开头。名称要体现出该页面的意义,最好能够与模块名称联系在一起。
    例如:
    login.jsp --登录页面
    register.jsp --注册页面
    message.jsp --客户留言页面

     

    四、J2EE项目工程文件夹组织规范:
    目的:规范学员web应用程序的资源组织形式,形成良好的文件组织习惯。文件的组织形式应当体现模块的划分。

    1.根据eclipse工具的特征,项目的目录结构为:


    src
    ----存放java文件 
    WebRoot
    |--images --存放web程序所需的公共图片
    |--css --存放web程序所需的公共样式表
    |--js --存放web程序所需的公共js文件
    |--commons --存放web程序所需的公共文件
    |--功能模块文件夹(存放与某个功能模块相关的资源)
    |--images --存放与该功能模块相关的图片
    |--css --存放与该模块相关的样式表文件
    |--js --存放与该模块相关的js文件
    |--jsp、html页面
    |--WEB-INF
    |--classes
    |--lib
    |--tld文件

    2.J2EE项目提交规范

          项目完成时要将项目作为一个产品交付用户,良好的项目组织规范可以使用户可以方便的找寻项目中需要的资源,同时也是一个公司专业性的体现。项目提交时,要按照下列文件格式进行提交。

    1)项目主文件夹:
    作用:存放项目其他资源文件。

    命名规范:时间_班级编号_第X小组。
    例如:070706_GS2T18_第四小组。


    2)项目主文件夹下面包括以下文件夹和文件:
    |--src:保存.java文件。
    |--database:保存数据库的脚本文件或者数据库备份文件。
    |--source:保存eclipse工程中WebRoot目录下的所有文件。
    |--depend:保存编译该程序必须依赖的其他jar文件。
    |--javadoc:保存所有类生成的javadoc api文档。
    |--war:保存程序的归档文件
    |--xx.war:已经打包好的工程文件,可以直接运行。
    |--project:保存开发项目原工程代码及文件。
    |--产品说明书.doc:图文方式展现该产品使用方法。
    |--build.xml:ant脚本,用于生成运行的war文件。
    |--项目解说.ppt:进行项目讲解的ppt(ppt仅供在校模拟项目使用,不用于其他商业用途)
    注:一个完整的项目中,数据库必须有一定量的有效的测试数据来支持该程序的运行

    3)包的命名  
         Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性,每一名Java程序员都可以编写属于自己的Java包,为了保障每个 Java包命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的,所以程序 员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。 
    例如: net.frontfree.javagroup 

    4)类的命名 
        类的名字必须由大写字母开头而单词中的其他字母均为小写;如果类名称由多个单词组成,则每个单词的首字母均应为大写例如TestPage;如果类名 称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的,所以在命名类时应尽量 选择名词。    
    例如: Circle 

    5)方法的命名 
        方法的名字的第一个单词应以小写字母作为开头,后面的单词则用大写字母开头。 
    例如: sendMessge 

    6)常量的命名 
    常量的名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线来分割这些单词。 
    例如: MAX_VALUE 

    7)参数的命名 
    参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。 

    8)Javadoc注释 
        Java除了可以采用我们常见的注释方式之外,Java语言规范还定义了一种特殊的注释,也就是我们所说的Javadoc注释,它是用来记录我们代 码中的API的。Javadoc注释是一种多行注释,以结束,注释可以包含一些HTML标记符和专门的关键词。使用Javadoc 注释的好处是编写的注释可以被自动转为在线文档,省去了单独编写程序文档的麻烦。 
    例如: 

        在每个程序的最开始部分,一般都用Javadoc注释对程序的总体描述以及版权信息,之后在主程序中可以为每个类、接口、方法、字段添加 Javadoc注释,每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能,这句话应单独占据一行以突出其概括作用,在这句话后面可以跟 随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落,例如上面例子中的@auther和@version,这 些段落将在生成文档中以特定方式显示。

    9)变量和常量命名
         变量命名的方法采用匈牙利命名法,基本结构为scope_typeVariableName,它使用3字符前缀来表示数据类型,3个字符的前缀必须 小写,前缀后面是由表意性强的一个单词或多个单词组成的名字,而且每个单词的首写字母大写,其它字母小写,这样保证了对变量名能够进行正确的断句。

         例如, 定义一个整形变量,用来记录文档数量:intDocCount,其中int表明数据类型,后面为表意的英文名,每个单词首字母大写。这样,在一个变量名就 可以反映出变量类型和变量所 存储的值的意义两方面内容,这使得代码语句可读性强、更加容易理解。byte、int、char、long、float、 double、boolean和short。

        变量类型和首字母对照关系如下表:
    数据类型/对象类型 / 变量前缀 / 备注 
    byte bye 
    char chr 
    float flt 
    boolean bln 做布尔变量时,使用bln 
    Integer/int int 
    String str 
    Single sng 
    short sht 
    Long/long lng 
    Double/double dbl 
    Currency cur 
    Variant bln astr obj vnt 做布尔变量用时,用bln,做字符串数组用时,用astr,做为对象使用时,用obj,不确定时,用vnt。
    对于数组,在数据类型的前缀前再增加一个a,例如字符串数组为astr。对于在多个函数内都要使用的全局变量,在前面再增加“g_”。例如一个全局的字符串变量:g_strUserInfo。

    10)在变量命名时要注意以下几点:
    · 选择有意义的名字,注意每个单词首字母要大写。

    · 在一段函数中不使用同一个变量表示前后意义不同的两个数值。

    · i、j、k等只作为小型循环的循环索引变量。 

    · 避免用Flag来命名状态变量。 

    · 用Is来命名逻辑变量,如:blnFileIsFound。通过这种给布尔变量肯定形式的命名方式,使得其它开发人员能够更为清楚
    的理解布尔变量所代表的意义。 

    · 如果需要的话,在变量最后附加计算限定词,如:curSalesSum。 

    · 命名不相包含,curSales和curSalesSum。

    · Static Final 变量的名字应该都大写,并且指出完整含义。 

    · 如果需要对变量名进行缩写时,一定要注意整个代码中缩写规则的一致性。例如,如果在代码的某些区域中使用intCnt,而在另一些区域中又使用intCount,就会给代码增加不必要的复杂性。建议变量名中尽量不要出现缩写。 

    · 通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。例如,请使用 strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。常 用的量词后缀有:First(一组变量中的第一个)、Last(一组变量中的最后一个)、Next(一组变量中的下一个变量)、Prev(一组变量中的上 一个)、Cur(一组变量中的当前变量)。

    · 为每个变量选择最佳的数据类型,这样即能减少对内存的需求量,加快代码的执行速度,又会降低出错的可能性。用于变量的数据类型可能会影响该变量进行计算所产生的结果。在这种情况下,编译器不会产生运行期错误,它只是迫使该值符合数据类型的要求。这类问题极难查找。

    · 尽量缩小变量的作用域。如果变量的作用域大于它应有的范围,变量可继续存在,并且在不再需要该变量后的很长时间内仍然占用资源。它们的主要问题是,任何类 中的任何方法都能对它们进行修改,并且很难跟踪究竟是何处进行修改的。占用资源是作用域涉及的一个重要问题。对变量来说,尽量缩小作用域将会对应用程序的 可靠性产生巨大的影响。 
    关于常量的命名方法,在JAVA代码中,无论什么时候,均提倡应用常量取代数字、固定字符串。也就是说,程序中除0,1以外,尽量不应该出现其他数 字。常量可以集中在程序开始部分定义或者更宽的作用域内,名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下 划线“_”来分割这些单词如:NUM_DAYS_IN_WEEK、MAX_VALUE。

    展开全文
  • 注: 个人支持踊跃参与国外开源项目. 此文面向读者仅为母语是中文的并有意原创开源项目的开发者. 源自在代码中推广中文命名对中国开源软件的意义 - V2EX. 中文命名的技术优势在对在代码中使用中文命名的质疑与回应&...
  • 代码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯。...目的:包的命名规范应当体现出项目资源良好的划分 servlet类所在包命名规范:公司名称.开发组名称.项目名称....
  • 商业项目中代码质量是否重要?

    千次阅读 2012-10-04 11:13:40
    在大多数商业项目中,代码质量并不被看重,因为大部分情况下,代码不是整个项目的最终产品,客户最终使用的是二进制文件,而不是源代码。相比代码质量,开发流程、进度和技能更能决定产品最终的质量。 在现实生活...
  • 软件项目版本号的命名规则及格式介绍 版本控制比较普遍的 3 种命名格式 :一、GNU 风格的版本号命名格式 :主版本号 . 子版本号 [. 修正版本号 [. 编译版本号 ]]英文对照 : Major_Version_Number.Minor_Version_...
  • html 命名规则

    千次阅读 2018-04-06 23:05:56
    命名规则项目命名全部采用小写方式, 以下划线分隔。例:my_project_name目录命名参照项目命名规则;有复数结构时,要采用复数命名法。例:scripts, styles, images, data_modelsEJS、JS文件命名原则实现同一页面的...
  • JavaWeb与JavaEE命名规则(规范)

    千次阅读 2017-10-28 14:31:30
    最近做的一个系统,做完之后发现命名有些不够规范,所以想要规范一下命名,这样才能使项目目录更规范与整齐,网上发现该详细的命名规范博文.但是有些命名规范已经有些不在适合,参考该博文的基础上,进行了修改. 在此感谢...
  • 软件编程命名方法+数据库命名

    千次阅读 2014-03-15 10:07:16
     正确并形象地函数、变量命名,不仅可以增加程序的可读性,也是程序员编程风格的一种反映。较好的命名习惯,可以有效的提高程序的可维护性。以下介绍几种常用的变量命名规则。  一、匈牙利命名法:广泛应用于...
  • 基于BERT预训练的中文命名实体识别TensorFlow实现

    万次阅读 多人点赞 2019-01-03 11:58:25
    BERT-BiLSMT-CRF-NER Tensorflow solution of ...使用谷歌的BERT模型在BLSTM-CRF模型上进行预训练用于中文命名实体识别的Tensorflow代码’ 代码已经托管到GitHub 代码传送门 大家可以去clone 下来亲自体验一下! g...
  • maxim芯片的命名规则

    千次阅读 2016-08-15 17:54:46
    MAXIM产品命名规则 点击浏览 : 自主产品的命名规则 | 用于军工和航天航空的器件型号 | 第二货源型号命名 自主产品的命名规则 绝大多数Maxim产品采用公司专有的命名系统,包括基础...
  • Android工程图片资源命名禁忌

    千次阅读 2014-01-14 13:50:43
    Android工程中,res\drawable\ 文件夹下所有的图片资源文件命名,不允许: 1. 大写字母 从Eclipse的这个报错可以知道资源文件的命名规则。 Invalid file name: must contain only [a-z0-9_.] 参考Android ...
  • 转一个开发命名规范

    千次阅读 2016-12-24 16:02:28
    目的:包的命名规范应当体现出项目资源良好的划分 servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet 例如:net.linkcn.web.servlet 自定义标签类所在包命名规范:公司名称.开发组名称.
  • 数据库命名规范

    千次阅读 2013-09-06 10:10:22
    命名编码规范 1.更改.... 4 2.简介.... 4 3.开发环境.... 4 3.1数据库模型... 5 3.2 Diagrams. 5 3.3版本控制... 5 3.4 源码目录结构... 5 4.物理数据库模型&字典.... 6 4.1 物理数据模型... 6
  • java 包名、类名命名规则

    万次阅读 2017-04-27 14:20:16
    目的:包的命名规范应当体现出项目资源良好的划分 servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet 例如:net.linkcn.web.servlet 自定义标签类所在包命名规范:公司名称.开发组名称.
  • 转一个J2EE开发时的包命名规则,养成良好的开发习惯 ...目的:包的命名规范应当体现出项目资源良好的划分 servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet 例如:net.linkcn.web.servlet
  • 目的:包的命名规范应当体现出项目资源良好的划分 servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet 例如:net.linkcn.web.servlet 自定义标签类所在包命名规范:公司名称.开发组名称.
  • 软件系统命名简称大全

    千次阅读 2021-02-06 14:32:40
    平时开发过程中需要一些标准化的命名,在开发或者定义中去查找很难临时的找到;今天吐血整理出来希望对大家或者我自己有帮助。 OMS (订单管理系统) WMS (仓储管理系统) TMS (运输管理系统) FMS (货代管理系统) ...
  • 软件命名规范

    千次阅读 2010-09-14 10:07:00
    优秀项目—档案—的命名惯例 用GNU风格的命名习惯,档案名加主版本号.辅版本号.补丁编号 让档案名称符合GNU命名规则是一个礼人利己的事情,GNU的命名规则是:以所有字母都小写的主名称作为前缀,后跟一个破折号,...
  • 命名实体识别以及词性自动标注

    千次阅读 2019-03-17 17:20:34
    基本任务包括利用分类与预测、聚类分析、关联规则、时序模式、偏差检测、智能推荐等方法,帮助企业提取数据中蕴含的商业价值,提高企业的竞争力。就是通过选择'多个特征',进行数据分析,得出结果。 简单介绍...
  • 在这方面,信息系统、IT 项目、信息技术管理等学科和课程可能被视为与“商业信息科学”一样重要和至关重要的领域。 印度在高等教育领域发展Swift,因此最近开发并启动了许多新分支,其中,数字营销是一个重要分支。...
  • 本文与大家聊一聊编程中非常关键的一个点,如何更好的对代码命名。先放出这篇文章所涉及内容知识点的一张思维导图,就开始正文。大家若是疲于阅读文章正文,直接看这张图,也是可以Get到本文的主要知识点的大概。 ...
  • groupid和artifactId被统称为“坐标”是为了保证项目唯一性而提出的,如果你要把你项目弄到maven本地仓库去,你想要找到你的项目就必须根据这两个id去查找。  groupId一般分为多个段,这里我只说两段,第一段为域...
  • 本文与大家聊一聊编程中非常关键的一个点,如何更好的对代码命名。   一、引言   《代码整洁之道》这本书提出了一个观点:代码质量与其整洁度成正比,干净的代码,既在质量上可靠,也为后期维护、升级奠定了...
  • 商业转载请联系作者获得授权,非商业转载请注明出处。不同的代码段采用不同的命名长度。通常来说,循环计数器(loop counters)采用1位的单字符来命名,循环判断变量(condition/loop variables)采用1个单词来命名...
  • 使用Allatori对Spring Boot项目进行代码混淆

    千次阅读 热门讨论 2018-02-27 11:31:00
    Allatori混淆技术介绍 ...对于教育和非商业项目来说这个混淆器是免费的。支持war和jar文件格式,并且允许对需要混淆代码的应用程序添加有效日期。 有项目需要对代码进行保护,比较初级的方案就是对代码进行...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 44,800
精华内容 17,920
关键字:

如何给商业项目命名