首页 诗词 字典 板报 句子 名言 友答 励志 学校 网站地图
当前位置: 首页 > 教程频道 > 软件管理 > 软件架构设计 >

java的代码轨范

2013-09-16 
java的代码规范一注释规则:1 注释方式a //,单行注释b,/*HHHHHH*/多行注释c,/**HHHHHH*/多行注释用于生成ja

java的代码规范

一  注释规则:

1 注释方式

a //,单行注释

b,/*HHHHHH*/多行注释

c,/**HHHHHH*/多行注释  用于生成javadoc文件

注意:提倡使用/**/这种注释,慎用单行注释


2 类,接口说明, 每一个类必须做出说明,类注释通常类或者接口的前面,类的注释要包括日期,版本号,作者,模块的目的和功能

/**

*@

*@
*@

*@

*/

public class Hello

{

}

3方法说明

每一个方法必须进行注释说明,说明方法的目的/功能,输出输入参数和返回值

    /**
     *
     * @param categoryId 根据产品属于哪个类别来查询
     * @param name 根据产品的名字
     * @param descr 根据对产品的描述
     * @param lowPrice    根据会员的最低价格
     * @param highPrice 根据会员的最高价格
     * @return 以List<>集合的形式返回给JSP页面,在遍历,拿出来要得到的结果
     */
    public  List<Product> searchProducts(int[] categoryId,
                                               String keyWord,
                                               double normalLowPrice,
                                               double normalHighPrice,
                                               double memberLowPrice,
                                               double memberHighPrice,
                                               Timestamp startDate,
                                               Timestamp endDate,
                                               int pageNo,
                                               int page);

4 类变量,常量说明

每一个类变量,常变量都要进行注释,说明其意义,作用。

public class HH

{

/**HH*/

public static int HH;

}

开发项目时的命名规则:

包:

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

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

数据库:
   表名:首字母大写+驼峰式命名 eg:Article;UserDept
   表中列名:首字母大写+驼峰式命名 eg:UserId;UnitCost
   存储过程命名:表名_首字母大写+驼峰式命名 eg:Admin_UserRegister

项目名称:
   公认简写:全部大写 eg:DAL;BLL
   其他:首字母大写+驼峰式命名 eg:DBUtility;OracleDAL

类:
   类名:首字母大写+驼峰式命名 eg:PetShop.cs;AssemblyInfo.cs
   私有变量名:_首字母小写+驼峰式命名 eg:_publishTime;_rootCategoryId
   公共属性名:首字母大写+驼峰式命名 eg:Description;PublishTime

函数:
   函数名:首字母大写+驼峰式命名 eg:GetItemByProduct
   参数名:首字母小写+驼峰式命名 eg:userId,itemInfo



热点排行