Java包、类、属性命名规范



- 命名规范

1、包

  • 包名命名,所有字母都小写。
  • 包命名的路径建议符合所开发的系统模块的定义,以便看了包命名就明白是哪个模块,从而直接到对应包里找相应的实现。
  • 由于Java面向对象的特性,每个Java开发人员都可以编写属于自己的包,为了保障每个包命名的唯一性,在最新的Java编程规范中,要求开发人员在自己定义的包名钱加上唯一的前缀。由于互联网上的域名称是不会重复的,所以多数开发人员采用自己公司的名称.项目名.模块名*.*.* ,在互联网上的域名称作为自己程序包的唯一前缀。例如:com.srrui.base.类
  • 个人项目包的推荐命名:
  1. indi:个人项目,指个人发起,但非自己独自完成的项目,可以公开或私有项目,版权主要属于发起者。例如:indi.发起者名.项目名.模块名*.*.*
  2. pers:个人项目,指个人发起,独自完成,可分享的项目,版权主要属于个人。例如:pers.个人名.项目名.模块名*.*.*
  3. priv:私有项目,指个人发起,独自完成,非公开的私人使用的项目,版权属于个人。例如:priv.个人名.项目名.模块名*.*.*
  • 团队项目包的推荐命名:
  1. team:团队项目指由团队发起,并由该团队开发的项目,版权属于该团队所有。例如:team.团队名.项目名.模块名*.*.*
  2. com:公司项目:由项目发起的公司所有。例如:包命名 com.公司名.项目名.模块名*.*.*

2、类名

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

3、方法名

  • 首字母小写,如果是由多个单词组成的画,每一个单词的首字母小写,其余单词首字母大写。

4、变量名

  • 推荐的命名规范有以下三种:
  1. Camel 标记法:首字母是小写的,接下来的单词都以大写字母开头。譬如:定义一个变量,用来记录文档数量:docCount
  2. Pascal 标记法:首字母是大写的,接下来的单词都以大写字母开头。譬如上例中的文档数量记录变量,则修订为:DocCount
  3. 匈牙利标记法:在以 Pascal标记法 的变量前附加小写小写序列说明该变量的类型。基本结构为:scope_typeVariableName,它使用1-3字符前缀来表示数据类型,3个字符的前缀必须小写,前缀后面是由表意性强的一个单词或多个单词组成的名字,而每个单词的首字母大写,其它字母小写。譬如:上例中定义文档数量记录的变量是一个整型变量,则应修订为:intDocCount
    通常在团队开发中,会预先设定统一的命名方式,以便于团队中项目的维护。
© 版权声明
THE END
喜欢就支持一下吧
点赞0 分享
评论 抢沙发
头像
欢迎您留下宝贵的见解!
提交
头像

昵称

取消
昵称表情代码图片