admin 管理员组文章数量: 887021
2024年2月19日发(作者:c语言入门视频教程下载)
JAVA文件夹命名规范
篇一:Java命名规范
命名规则
包的命名
Java包的名字都是由小写单词组成。
例如: .e
类的命名
类的名字必须由大写字母开头而单词中的其他字母均为小写;如果类名称由多个单词组成,则每个单词的首字母均应为大写例如TestPage;如果类名称中包 含单词缩写,则这个所写词的每个字母均应大写,如:XMLExample例如: Circle
方法的命名
方法的名字的第一个单词应以小写字母作为开头,后面的单词则用大写字母开头。
例如: sendMessge
Dao层类尽量不去修改,由于Dao层是通用性强的一些方法,只要在service层调用即可。在service层,方法的功能是进行增、删、改操作的话,方法名字由其功能决定需要添加前缀。以便之后事务的管理。其他功能的方法按照命名规则即可。
例如: ins_Rigester(注册) upd_Update(修改)
del_Delete(删除)
接口命名原则
使用名词或名词短语,或者描述行为的形容词来命名接口,使用Pascal大写。 减少接口名中缩写的使用量,在接口名前加前缀I,以表示这个类型是一个接口。
例如: IComponent(描述性名词)
ICustomAttributeProvider(名词短语)
IPersistable(形容词)
常量的命名
常量的名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线来分割这些单词。
例如: MAX_VALUE
参数的命名
参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。 Javadoc注释
Java除了可以采用我们常见的注释方式之外,Java语言规范还定义了一种特殊的注释,也就是我们所说的Javadoc注释,它是用来记录我们代码 中的API的。Javadoc注释是一种多行注释,以/**开头,而以*/结束,注释可以包含一些HTML标记符和专门的关键词。使用Javadoc注释 的好处是编写的注释可以被自动转为在线文档,省去了单独编写程序文档的麻烦。
例如:
/**
* This is an example of
* Javadoc
*
* @author darchon
* @version 0.1, 10/11/2002
*/
JSP文件夹命名
以功能或者对象为一个模块、部分,命名时尽量以一个单词来命名,首字母大写。如果文件夹内存放某一类型的文件,则以该类文件的特性来命名,首字母大写。
例如: Transport
Css(样式表), Javascript(脚本文件)
Flash(flash文件),Image(图片文件)
文件命名:
首先确定其存放位置,文件命名规则由所在文件夹以及本页面所体现功能来命名。 如果名称由多个单词组成,则应该用下划线来分割这些单词
例如: customer_
编码格式都为GBK
数据库命名规则:
由前缀+模块功能+详细内容 组成例如bster_transport_car
运输汽车表
篇二:java命名规范
JAVA命名规范
1. 包名
包名采用域名后缀倒置的加上自定义的包名,采用小写字母。自定义的包名采用产品名称加模块名称。
格式:
.产品名.模块名
示例:
门户产品用户管理模块
2. 类和接口名
类和接口名使用意义完整的英文描述,每个单词首字母使用大写、其余字母使用小写的大小写混合法。
示例:
UserList, OrderInfo, ReportService, StringUtils
3. 方法名
方法名使用意义完整的英文描述,第一个单词字母使用小写、剩余单词首字母使用大写、其余字母使用小写的大小写混合法。方法中,动作方法采用动宾结构。 示例: private void
getOrderList();
public void saveReportConfig();
4. 属性名
属性名使用意义完整的英文描述,第一个单词字母使用小写、剩余单词首字母使用大写、其余字母使用小写的大小写混合法。
示例:
private String customerName;
privateintloginCounts;
5. 常量名
常量名使用全大写的英文写法,英文单词之间用下划线隔开,并且使用final static修饰。 示例: Public final static
int MAX_VALUE = 1000;
Public final static String DEFAULT_PAGE =
“”;
篇三:JAVA基本命名规范
基本命名规范
包命名
包名按照域名的范围从大到小逐步列出,恰好和Internet上的域名命名规则相反。
由一组以―。‖连接的标识符构成,通常第一个标识符为符合网络域名的两个或者三个英文小写字母。
People TestPage XMLExample
类,接口命名
类的名字必须由大写字母开头而单词中的其他字母均为小写;如果类名称由多个单词组成,则每个单词的首字母均应为大写例如
TestPage;如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的,所以在命名类时应尽量选择名词。
People TestPage XMLExample
方法名
方法的名字的第一个单词应以小写字母作为开头,后面的单词则用大写字母开头。可以为动词或动词+名词组合。
设置/获取某个值的Method,应该遵循setV/getV规范返回长度的Method,应该命名为length
测试某个布尔值的Method,应该命名为isV
将对象转换为某个特定类型的Mehod应该命名为toF
getDate(); length(); isReady(); toOracleFormat();变量名
1.普通变量命名应该采用首字母小写,其他字母首字母大写的方式。
static变量的名字应该都大写,并且指出完整含义。如果一个常量名称由多个单词组成,则应该用下划线来分割这些单词如。NUM_DAYS_IN_WEEK MAX_VALU
3. 如果需要对变量名进行缩写时,一定要注意整个代码中缩写规则的一致性
context=ctx message=msg
4. 通过在结尾处放置一个量词,就可创建更加统一的变量First(一组变量中的第一个) Last(一组变量中的最后一个)
Next(一组变量中的下一个变量) Prev(一组变量中的上一个)
Cur(一组变量中的当前变量)
5. 无论什么时候,均提倡应用常量取代数字、固定字符串。也就是说,程序中除0,1以外,尽量不应该出现其他数字。
6. 索引变量:i、j、k等只作为小型循环的循环索引变量。
7. 逻辑变量:避免用flag来命名状态变量,用is来命名逻辑变量。if(isClosed){ dosomeworks; return; }
数组
总是使用以下方式定义数组:
int[] arr = new int[10];
禁止使用C语言的是形式:
禁止 int arr[] = new int[10];
集合
数组或者容器推荐命名方式为名词+s的方式,例如:
List persons = getPerson(); for(Person person :
persons){ dosomeworks; }
泛型
应该尽量简明扼要(最好是一个字母),以利于与普通的class或interface区分
Container中的Element应该用E表示;Map里的key用K表示,value用V;Type用T表示;异常用X表示
如果需要接收多个Type类型的参数,应该用邻接T的大写字母——例如S——来依次表示,当然也可以用T1, T2这样的方式
public class HashSet extends AbstractSet {…} public
class HashMap extends AbstractMap {…} public class
ThreadLocal {…} public interface Functor { T val()
throws X; }
推荐的命名
1.当要区别接口和实现类的时候,可以在类的后面加上―Impl‖。interface Container class C
ontainerImpl
ion类最好能用―Exception‖做为类命名的结尾DataNotFoundException InvalidArgumentException
3.抽象类最好能用―Abstract‖做为类命名的开头
AbstractBeanDefinition AbstractBeanFactory
4. Test类最好能用―Test‖做为类命名的结尾
ContainerTest
5.简称与缩写(不推荐使用)
cp代表colorPoint buf代表buffer off代表offset len代表length
版权声明:本文标题:JAVA文件夹命名规范 内容由网友自发贡献,该文观点仅代表作者本人, 转载请联系作者并注明出处:http://www.freenas.com.cn/free/1708351277h520981.html, 本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容,一经查实,本站将立刻删除。
发表评论