文章

【读书笔记】《java从小白到大牛》命名规范

命名规范

程序代码中到处都是标识符,因此取一个一致并且符合规范的名字非常重要。命名方法很多,但是比较有名的且被广泛接受的命名法包括下面两种。

匈牙利命名,一般只是命名变量,原则是:变量名 = 类型前缀 + 描述,如bFoo表示布尔类型变量,pFoo表示指针类型变量。匈牙利命名还是有一定争议的,在Java编码规范中基本不被采用。

驼峰命名(Camel-Case),又称“骆驼命名法”,是指混合使用大小写字母来命名。驼峰命名又分为小驼峰法和大驼峰法。小驼峰法就是第一个单词是全部小写,后面的单词首字母大写,如myRoomCount;大驼峰法是第一个单词的首字母也大写,如ClassRoom。

除了包和常量外,Java编码规范命名方法采用驼峰法,下面分类说明一下。

  • 包名:包名是全小写字母,中间可以由点分隔开。作为命名空间,包名应该具有唯一性,推荐采用公司或组织域名的倒置,如com.apple.quicktime.v2。但Java核心库包名不采用域名的倒置命名,如java.awt.event。
  • 类和接口名:采用大驼峰法,如SplitViewController。
  • 文件名:采用大驼峰法,如BlockOperation.java。
  • 变量:采用小驼峰法,如studentNumber。
  • 常量名:全大写,如果是由多个单词构成,可以用下划线隔开,如YEAR和WEEK_OF_MONTH。
  • 方法名:采用小驼峰法,如balanceAccount、isButtonPressed等。

注释

Java中注释的语法有三种:

单行注释(//)

多行注释(/*...*/)

文档注释(/**...*/)

许可协议:  CC BY 4.0