Java的一些命名规范

1,103 阅读4分钟

因为网上包含太多的Java基础教程,这里就不过多讲解。

推荐几个学习的网站。

菜鸟教程

大佬的官方网站

高淇老师的Java300集

Java的基础语法

  • 大小写敏感:Java 是大小写敏感的,这就意味着标识符 Hellohello 是不同的。
  • 类名:对于所有的类来说,类名的首字母应该大写。如果类名由若干单词组成,那么每个单词的首字母应该大写,例如 MyFirstJavaClass
  • 方法名:所有的方法名都应该以小写字母开头。如果方法名含有若干单词,则后面的每个单词首字母大写。
  • 源文件名:源文件名必须和类名相同。当保存文件的时候,你应该使用类名作为文件名保存(切记 Java 是大小写敏感的),文件名的后缀为 .java。(如果文件名和类名不相同则会导致编译错误)。
  • 主方法入口:所有的 Java 程序由 public static void main(String[] args) 方法开始执行。

Java 标识符

Java 所有的组成部分都需要名字。类名变量名以及方法名都被称为标识符

关于 Java 标识符,有以下几点需要注意

  • 所有的标识符都应该以字母(A-Z 或者 a-z),美元符($)、或者下划线(_)开始
  • 首字符之后可以是字母(A-Z 或者 a-z),美元符($)、下划线(_)或数字的任何字符组合
  • 关键字不能用作标识符
  • 标识符是大小写敏感的
  • 合法标识符举例:age、$salary、_value、__1_value
  • 非法标识符举例:123abc、-salary

在标识符的起名规则上,在开发过程中一般要使用小驼峰规则命名。

下面做一个示范。

我们简单的创建一个学生类

/**
 * author pilipala
 */
public class Student {

    //以下都是变量命名方式
    //学生姓名
    private String name;
    //学生编号
    private String studentNO;
    //学生性别
    private String sex;
    //学生邮箱
    private String email;
    //班级名称
    private String className;

    //以下是常量命名方式

    public static final String IDENTITY_NUMBER = "218328492746294769";

    //以下是方法名命名方式
    public void learn() {
        System.out.println("learn()");
    }
}

总结一下,类名每个单词的首字母都需要大写,变量名的第一个单词首字母不需要大写其余单词首字母全部大写,常量的命名方式比较特殊,需要全部大写而且每个单词中间要用“_”分隔,方法名的命名规则和变量名相同。

为什么要这样命名?自己随心所欲不好吗?

想象一下在以后的开发过程中如果你和你的同事编写出来的代码连命名规则都不统一,你的同事如果阅读你的代码,那每次都要去问你这个变量是做什么的?有什么用?非常影响开发效率。所以我们应该在刚开始编程的时候养成一个良好的习惯。

其实现在也有很多比较自动化的框架会直接把数据库字段生成为POJO(Plain Ordinary Java Object)类。一般就是以驼峰规则转换,所以命名的统一还是很重要的。

注释和注解

我们写的代码可能自己能看懂,但是别人阅读起来可能比较麻烦,这时候就需要我们使用注释。注释的使用方法有几种。

  1. 单行注释://……
  2. 块(block)注释:/*……*/
  3. 文档注释:/**……*/
  4. javadoc 注释标签语法
  • @author 对类的说明 标明开发该类模块的作者
  • @version 对类的说明 标明该类模块的版本
  • @see 对类、属性、方法的说明 参考转向,也就是相关主题
  • @param 对方法的说明 对方法中某参数的说明
  • @return 对方法的说明 对方法返回值的说明
  • @exception 对方法的说明 对方法可能抛出的异常进行说明

我们把上面的学生类稍微改一点点,变成下面这个样子。

/**
 * @author pilipala
 */
public class Student {

    //以下都是变量命名方式
    //学生姓名
    private String name;
    //学生编号
    private String studentNO;
    //学生性别
    private String sex;
    //学生邮箱
    private String email;
    //班级名称
    private String className;

    //以下是常量命名方式

    public static final String IDENTITY_NUMBER = "218328492746294769";

    //以下是方法名命名方式
    /**
     * @return 返回为空
     */
    public Student learn() {
        /*
         * 学生学习
         */
        System.out.println("learn()");
        return new Student();
    }
}

然后我们使用JDK的javadoc将这个类生成一个文档,

可以看到我们的代码目录里生成了许多的文件,这就是我们学生类的文档。

双击Student.html这个网页就可以看到Student的文档了。

我们在注释标签后添加的内容也被添加到文档中了。

 //以下是方法名命名方式
    /**
     * @return 返回为空
     */

就是这一段内容。

如果我们写完的代码需要给别人使用或者查看,直接在代码中编写文档注释然后使用javadoc Student.java -encoding utf-8 命令就可以直接生成一个文档给他看了。