zoukankan      html  css  js  c++  java
  • JAVA项目命名规范

    一、命名规范

    1、 项目名全部小写

    2、 包名全部小写

    3、 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。

    如:public class MyFirstClass{}

    4、 变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。

    如:int index=0;

           public void toString(){}

    5、 常量名全部大写

    如:public static final String GAME_COLOR=”RED”;

    6、所有命名规则必须遵循以下规则:

    1)、名称只能由字母、数字、下划线、$符号组成

    2)、不能以数字开头

    3)、名称不能使用JAVA中的关键字。

    4)、坚决不允许出现中文及拼音命名。

    二、注释规范

    1、   类注释

    在每个类前面必须加上类注释,注释模板如下:

    /**

    * Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.

    * FileName: Test.java

    * 类的详细说明

    *

    * @author 类创建者姓名
        * @Date    创建日期

    * @version 1.00

    */

    2、   属性注释

    在每个属性前面必须加上属性注释,注释模板如下:

    /** 提示信息 */

    private String strMsg = null;

    3、   方法注释

    在每个方法前面必须加上方法注释,注释模板如下:

    /**

    * 类方法的详细使用说明

    *

    * @param 参数1 参数1的使用说明

    * @return 返回结果的说明

    * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

    */

    4、   构造方法注释

    在每个构造方法前面必须加上注释,注释模板如下:

    /**

    * 构造方法的详细使用说明

    *

    * @param 参数1 参数1的使用说明

    * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

    */

    5、   方法内部注释

    在方法内部使用单行或者多行注释,该注释根据实际情况添加。

    如://背景颜色

           Color bgColor = Color.RED

    补充:

    1. JAVA源文件的命名  JAVA源文件名必须和源文件中所定义的类的类名相同。

    2. Package的命名  Package名的第一部分应是小写ASCII字符,并且是顶级域名之一,通常是com、edu、gov、mil、net、org或由ISO标准3166、1981定义的国家唯一标志码。Package名的后续部分由各组织内部命名规则决定,内部命名规则指定了各组件的目录名,所属部门名、项目名等。   

    3. Class/Interface的命名  Class名应是首字母大写的名词。命名时应该使其简洁而又具有描述性。异常类的命名,应以Exception结尾。Interface的命名规则与Class相同。

    接口(Interface):采用完整的英文描述符说明接口封装,所有单词的第一个字母大写。习惯上,名字后面加上后缀 able, ible 或者 er。例如:Contactable,Prompter。

    组件(Component)使用完整的英文描述来说明组件的用途,末端应接上组件类型。例如:okButton,customerList,fileMenu。

    Jsp页面命名:
    命名规范: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仅供在校模拟项目使用,不用于其他商业用途)

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

  • 相关阅读:
    关于loose.dtd和xhtml1transitional.dtd等文档类型定义模型中CSS失效的解决办法。
    JSON扫盲帖+JSON类教程
    jQuery中Ajax事件
    JQuery绑定事件 时如何传递参数
    xml include 另外一个xml文件
    ubuntu 两张网卡时网络设置
    Letcode 题:pow(x,n)
    Java编程语言中sleep()和yield()的区别
    JProfiler与eclipse集成
    zz 字符串相关
  • 原文地址:https://www.cnblogs.com/dongming-03/p/4838906.html
Copyright © 2011-2022 走看看