用户注册



邮箱:

密码:

用户登录


邮箱:

密码:
记住登录一个月 忘记密码?

发表随想


还能输入:200字

小蜜锋    -  云代码空间

—— 技术宅拯救世界!

Java编程命名规范

2012-12-11 | 4046阅 | |

摘要:   一、(Package)包的命名   Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性,每一名Java程序员都可以编写属于自己的Java包,为了保障每个 Java包命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加

  一、(Package)包的命名 

  Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性,每一名Java程序员都可以编写属于自己的Java包,为了保障每个 Java包命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的,所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。

  例如:    net.frontfree.javagroup

  二、(Class)类的命名

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

  例如:    Circle

  三、方法的命名

  方法的名字的第一个单词应以小写字母作为开头,后面的单词则用大写字母开头。

  例如:    sendMessge

  四、参数的命名

  参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。

  五、Javadoc注释

  Java除了可以采用我们常见的注释方式之外,Java语言规范还定义了一种特殊的注释,也就是我们所说的Javadoc注释,它是用来记录我们代码中的API的。Javadoc注释是一种多行注释,以/**开头,而以*/结束,注释可以包含一些HTML标记符和专门的关键词。使用Javadoc 注释的好处是编写的注释可以被自动转为在线文档,省去了单独编写程序文档的麻烦。

  例如:

  /**

  *    This    is    an    example    of

  *    Javadoc

  *

  *    @author    darchon

  *    @version    0.1,    10/11/2002

  */

  在每个程序的最开始部分,一般都用Javadoc注释对程序的总体描述以及版权信息,之后在主程序中可以为每个类、接口、方法、字段添加 Javadoc注释,每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能,这句话应单独占据一行以突出其概括作用,在这句话后面可以跟随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落,例如上面例子中的@auther和@version,这些段落将在生成文档中以特定方式显示。

  六、变量命名

  变量命名应该采用首字母小写,其他字母首字母大写的方式。

  · Static    Final    变量的名字应该都大写,并且指出完整含义。

  · 如果需要对变量名进行缩写时,一定要注意整个代码中缩写规则的一致性。例如,如果在代码的某些区域中使用intCnt,而在另一些区域中又使用intCount,就会给代码增加不必要的复杂性。建议变量名中尽量不要出现缩写。

  · 通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。例如,请使用 strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。常用的量词后缀有:First(一组变量中的第一个)、Last(一组变量中的最后一个)、Next(一组变量中的下一个变量)、Prev(一组变量中的上一个)、Cur(一组变量中的当前变量)。

  · 为每个变量选择最佳的数据类型,这样即能减少对内存的需求量,加快代码的执行速度,又会降低出错的可能性。用于变量的数据类型可能会影响该变量进行计算所产生的结果。在这种情况下,编译器不会产生运行期错误,它只是迫使该值符合数据类型的要求。这类问题极难查找。

  · 尽量缩小变量的作用域。如果变量的作用域大于它应有的范围,变量可继续存在,并且在不再需要该变量后的很长时间内仍然占用资源。它们的主要问题是,任何类中的任何方法都能对它们进行修改,并且很难跟踪究竟是何处进行修改的。占用资源是作用域涉及的一个重要问题。对变量来说,尽量缩小作用域将会对应用程序的可靠性产生巨大的影响。

  七、关于常量的命名方法,在JAVA代码中,无论什么时候,均提倡应用常量取代数字、固定字符串。也就是说,程序中除0,1以外,尽量不应该出现其他数字。常量可以集中在程序开始部分定义或者更宽的作用域内,名字应该都使用大写字母,并且指出该常量完整含义。如果一个常量名称由多个单词组成,则应该用下划线“_”来分割这些单词如:NUM_DAYS_IN_WEEK、MAX_VALUE。

  八、推荐的命名

  1、类名推荐

  当要区别接口和实现类的时候,可以在类的后面加上“Impl”。例如: interface Container ,class ContainerImpl

  class Container3PImpl

  class ContainerYICTImpl

  2、Exception类名推荐

  Exception类最好能用“Exception”做为类命名的结尾。例如:

  DataNotFoundException

  InvalidArgumentException

  3、抽象类名推荐

  抽象类最好能用“Abstract”做为类命名的开头。例如:

  AbstractBeanDefinition

  AbstractBeanFactory

  4、Test类名推荐

  Test类最好能用“Test”做为类命名的结尾。例如:

  ContainerTest

  5、工厂类方法推荐

  工厂方法最好能把该方法做要创建的对象类型描述出来。例如:

  public Container createContainer();

  public Location newLocation();

  · 虽然为一个设计低劣的程序添加注释不会使其变成好的程序,但是如果按照编程规范编写程序并且为程序添加良好的注释却可以帮助你编写出设计完美,运行效率高且易于理解的程序,尤其是在多人合作完成同一项目时编程规范就变得更加重要。俗话说“磨刀不误砍柴工”,花费一点时间去适应一下Java编程规范是有好处的。

顶 8 踩 1 收藏
分享到:
更多
文章评论
共3 条评论 1/1页
发表评论

个人资料

  • 昵称: 小蜜锋
  • 等级: 高级设计师
  • 积分: 7674
  • 代码: 750 个
  • 文章: 357 篇
  • 随想: 211 条
  • 访问: 947 次
  • 关注

标签

设计模式(4) java(9) 命名规范(2) 广告创意(1) 愤怒的小鸟(1) 游戏(5) jsp(1) 配置(1) Surface(1) windows(1) javabean(1) 设计方法(1) 开发工具(2) web(4) 大数据(2) GPU(1) 硬盘(1) 内部结构(1) 黑客(1) 窃取(1) 编码(1) 解决方法(1) php(28) mysql(9) 数据库备份(1) 数据库还原(1) 命令(2) 数据库(1) 安装(1) 2012(2) 世界末日(3) 仙剑5前传(1) 默哀(1) 电源(1) 女生(1) 装饰器模式(2) 古剑奇谭(1) 电脑桌(1) 史上最牛(1) 编程语言(2) 小米(3) 电视机顶盒(1) 营销策略(1) Android(8) 手势(1) 诺亚方舟(1) Eclipse(1) 汽车(1) 操作系统(1) 软件(1) 互联网(5) 大事记(1) 设计师(2) 壁纸(1) 古剑奇谭2(1) 古剑奇谭网络版(1) 云计算(2) 服务器(1) 框架(2) Socket(1) jquery(1) 构造函数执行顺序(1) 火车票(1) 3D(1) 数据中心(2) 正则表达式(2) Web前端(1) 开发框架(1) 系统瘫痪(1) 12306(2) cpu(1) javascript(2) 开发日记(15) 体育馆管理系统(15) 网页设计(1) CSS3(3) 腾讯(3) 小游戏(1) interface(1) 平板(2) 面试(2) 设计(5) 摄影(2) 数据挖掘(1) 钢琴谱(1) 情人节(1) 陈欧体(1) 程序员(3) 漫画(1) UserAgent(1) iPhone(2) NoSQL(1) ui(9) 越狱(1) 指南(1) abstract(1) css(3) git(2) 八核(2) 三星(1) linux(11) 数据类型(1) html5(2) UML(2) perftools(1) 创意(1) logo(1) 色谱(1) 响应式(5) Metro(2) 虚拟机(1) jvm(1) 垃圾回收(1) left(1) join(1) 连接查询(1) 溯源系统(1) Override(1) SAE(2) WordPress(1) 指针(1) 链表(1) 系统分析师(1) 中间件(1) corba(1) static(1) 无线(1) 监控(1) iPad(1) Apache(2) 比特币(2) 命名规则(1) 手机支付(1) curl(3) 笔记(1) 导航(1) thinkphp(1) 异常导致本地路径泄漏(1) web设计(1) 网络安全(1) 诗句(1) 4K对齐(1) 代码库(1) 色彩(1) 动画片(1) struts2(3) 漏洞(5) 确认框(1) 心情驿站(1) ArscEditor(1) resources.(1) apktool(1) AppKey(1) 新浪微博(1) app(5) 广告(3) 赚钱(1) 响应式布局(1) html(1) 淘宝(2) 微信(1) 重构(5) 缓存(1) 破解(1) 后门(1) 七夕(1) SEO(2) 概念设计(1) 面向对象(1) bootstrap(1) 性能(2) 优化(1) iis(1) 爬虫(1) 采集(1) 算法(2) 文本相似度(2) cto(1) js(1) fsockopen(1) 扁平化设计(2) 网页(1) 心情(7) 小米电视(1) 开箱(1) 励志(2) 招聘(3) 命名(1) notepad++(1) python(1) 配色(3) 扁平化(4) ps(2) 搞笑(2) 创业(3) 渲染(1) 电影(1) 模板(1) 微博(1) 企业家(1) 公司(1) 总结(1) 前端(1) 运营(1) 变形(1) svn(4) 教程(3) 搜狗(1) 泄密(1) 双11(1) 天猫(1) UC(1) 启动界面(1) 光棍节(1) 双十一(2) 物流(1) 备份(1) 更新(1) 插入(1) 插件(2) jsTree(1) (1) 海量数据(1) 分辨率(1) 草图(1) 手绘(1) 速度(1) 文本处理(1) 实习(1) 感想(1) 文件(1) 简历(1) 65.49.2.17(1) yum(1) 解决办法(1) 阿里云(2) 推广(1) 来往(1) 春运(1) LBS(1) gb2312(1) utf-8(1) log4j(1) 详解(1) 收购(1) 私服(1) TortoiseGi(1) post(1) 异常(2) flappyBird(1) 应用创新大赛(1) 宙斯杯(1) 学习方法(1) xp(1) 退役(1) 安全(1) 技术贴(1) flash(1) 刷机(1) 京东(1) 电商(1) Tomcat(1) JDK(1) 免费(1) 长投影(1) 图标(1) Photoshop(1) 云端集成开发环境(1) 软件开发(1) 可视化(1) 工具(2) OpenSSL(1) Heartbleed(1) vsftp(1) 中国知网(1) 学术论文(1) 免费下载(1) 开发(1) 手册(1) 速查表(1) 追随战略(1) sdk(1) 文章(1) 发布(1) 文件管理(1) 沙画(1) 动效(2) 原型(1) 感悟人生(1) 哲理(1) Bash(1) 类图(1) 知识管理(1) Console(1) 调试命令(1) rpm(1) 报错(1) 挂载(1) 数据盘(1) 云主机(1) 产品经理(1) 原型设计(1) mql4(1) mt4(1) ea(1) 程序化交易(1) CURLOPT_PO(1) 阿里云​(1) CentOS6(2) OpenSSH(1) 漏洞修复(2) 升级(1) 安骑士(1)

站长推荐