Java编码规范

  • 规范原则
  • 尽量使用完整的英文描述符;
  • 采用大小写混合使名字可读,采用适用于相关领域的术语;
  • 尽量少用缩写,若已使用尽量明智,且在整个文件或工程中通用;
  • 避免使用长的和类似的名字,或仅仅是大小写不同的名字;
  • 除静态常量外,尽量少用下划线。

  • 源文件命名规则

  • 源程序中包含有公共类的定义,源文件名必须与该公共类的名字一致。在一个源程序中至多只能有一个公共类的定义
  • 源程序中不包含公共类,则该文件名只要和某个类名字相同即可;
  • 源程序中有多个类的定义,编译时将会为每个类生成一个 class 文件

  • 包:包名是全小写的名词,中间可以由点分隔开,如java.awt.event

  • 类/接口:类/接口名首字母大写,若由多个单词合成一个类名,要求每个单词的字母也要大写,如MyFirstJava
  • 方法:由多个单词组成的方法名首字母小写,中间的每个单词首字母大写,如isButtonPressed
  • 变量: 一般全小写,如length
  • 常量:一般全大写,如果由多个单词组成则中间用下划线相连。如果是对象类型的常量,则是大小写混合,由大写字母把单词隔开,如STR_LENGTH
  • 组件:使用完整的英文描述来说明组件的用途,尾部应该加上组件类型,如okButton