Java编程02之Java编码规范

第三章 Java编码规范

标识符的关键字

• 标识符：类名，接口，变量，方法，常量等。需要严格遵守命名规则，尽量按照统一的命名规范进行命名
  

规则规范

属于语法机制，必须遵守，否则编译不能通过

• 标识符只能由字母、数字、下划线_、美元符号$组成，不能含有其他符号

• 不能以数字开头

• 不能使用Java关键字

• 严格区分大小写

• 尽量按照统一的规范来进行命名，不符合也可以编译通过，但是不专业

  • 见名知义
  • 遵循驼峰命名方式

• 类名，接口名:

  • 单个单词：首字母大写，其余小写（小驼峰命名）：Hello
  • 多个单词：每个单词首字母都大写，其余单词小写（大驼峰命名）：HelloWorld

• 变量名，方法名：

  • 单个单词：字母全小写：check()
  • 多个单词：首字母小写，后面每个单词首字母大写：checkUserName()

• 常量名

  • 单个单词：字母全大写：NUMBER
  • 多个单词：字母全部大写，单词和单词之间使用"_"隔开：MAX_VALUE

Java关键字

• 关键字是SUN公司开发java语言的时候，提前定义好的一些具有特殊含义的单词，全部小写，不能作为标志符。（截图不清晰，需要找个清晰的）
  

文档注释，单行注释和多行注释

三种注释

• 单行注释： // （单行注释可以嵌套）
• 多行注释：/…/ （多行注释不可以嵌套）
• 文档注释：/**…*/ （文档注释javadoc生成的文档）

// 在目录d:\help下可看到和类名同名的Test.html帮助文档
javadoc -d d:\help -author -version HelloWorld.java

Elipse工具和模板

Elipse

• 下载安装
• 基础配置切换空间
• 设置字符集
• 设置注释模板
• 设置类注释
• 设置方法注释
• 创建Maven工程
  IDEA

华为Java编程军规

注释

• 源程序注释量必须在30%以上
• 注释的内容要清除，明了，含义准确

排版规则一

• 程序块要采用缩进风格编写，缩进的空格数为4个
• 不允许使用TAB缩进

排版规则二

• 分界符（如大括号{}）应各独占一行，同时与引用它们的语句左对齐

排版规则三

• 较长的语句、表达式或参数（>80字符）要分成多行书写

排版规则四

• 不允许把多个短语句写在一行中，即一行只写一条语句

排版规则五

• if、for、do、while、case、switch、default 等语句各占一行
• if、for、do、while等语句的执行语句部分无论多少都要加括号{}

命名规则一-类名和接口

• 类名和接口使用意义完整的英文描述
• 每个英文单词的首字母大写，其余字母使用小写的大小写混合法：

命名规则二-方法名和属性名

• 方法名和属性名使用意义完整的英文描述
• 第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法：

命名规则三-常量名

• 常量名使用全大写且意义完整的英文描述
• 英文单词之间用下划线分隔开，并且使用static final修饰

public class LogConfig
{
    public static final int MAX_VALUE = 1000;
    private int orderNum;
    public void addNewOrder()
    {
    }
}