您好,欢迎来到百家汽车网。
搜索
您的当前位置:首页Java的命名规范

Java的命名规范

来源:百家汽车网
一 命名(必须)

团队名称

白手党

包命名 com.global.bigshowparty(队名).callforstudent(项目).模块名.bill || dao ||

servlet (层名)

eg : com.global.bigshowparty.callforstudent.use.bill

名词或形容词, 每个单词首字母大写,单词要完整,除非公共缩写; eg: StudentInformation 类相同, 开头 以 \"I\"为前缀 eg: IStudentInformation

由接口首单词开头,以 \"Impl\" 结束为后缀 eg: StudentGroupImpl

类名

接口

接口实现类

方法

小写单词开头,至少两个单词.首单词必须为动词, 后继单词首字母大写

eg: setStudentName

首单词小写,至少两个单词,首单词小写, 且为名词,

后继单词首字母大写, 如果是临时的 就可以 用 类型作为前缀. eg: studentName eg: intTemp

单词每字母要大写,用\"_\"隔开, 类型_类名_(用途)

以 \"Exception\" 结尾; eg: SqlThrowsException 以\"Abs\" 开头;

eg: AbsStudentInformation 以Test结尾 或着建立个test包 eg: SqlResulstTest

用前缀方式 切前缀加\"array\"

eg: String [][] arrayStudentName = new String[2][2];

变量

常量

Exception类

抽象类

Test类

数组命名

ArrayList

以 “al\" 开头

Java源文件必须由一个单一的公共类或接口,若私有类和口与一个公共类相关联,可将他

们和公共类放入一个源文件,且公共的必须是

二注释

文件头

/**

*@copyright © //2004 北京``公司

*@description //本系统是商用软件……是非法的 *@version 版本号 *@date 日期 *@auther 作者 */

/**

*@classname 类名 属性

*@description //l类名, 用途,功能,属性

*@see //查看相关信息 如类信息 //可以不填内容 但要有@see 标记 *@version 版本 *@author 作者名 */

变量

/**

*@description 功能=== *@name 变量 *@type

*@see //查看相关信息 如类信息 //可以不填内容 但要有@see 标记 * /

方法

/**

*@method description 方法名, 功能

*@param 变量,参数列表,(每个@param 后只有一个变量或只有一个参数) // 要

说明类型功能

*@return description有返回值的方法必须注明 返回值类型 *@exception

*@throws 二选一,要注明 抛出的异常是什么类型,从哪来的e

*@see //查看相关信息 如类信息 //可以不填内容 但要有@see 标记 */

其他

在注释中用{@docRoot} 标记文档目录路径

在注释中用{@link name label} 标注 内联超文本连接 *@since 什么时间由谁改的

三 顺序(提倡)

开头注释

import 包 (导包最好不要加\"*\"); java.* javax.*; org.*; com.*;

类与接口定义

静态变量,实例变量 public,protected,private;

构造方法 方法定义顺序

public(自己的方法) 实现接口方法 重载public 方法

protected (受保护方法)

四 编码格式 codestyle

写完以后 用elcipse 格式化 标准为 Eclipse [built-in]

因篇幅问题不能全部显示,请点此查看更多更全内容

Copyright © 2019- baijiahaobaidu.com 版权所有 湘ICP备2023023988号-9

违法及侵权请联系:TEL:199 18 7713 E-MAIL:2724546146@qq.com

本站由北京市万商天勤律师事务所王兴未律师提供法律服务