java命名与注释

一、命名

package com.yh;

/**
 * @Author ASUS
 * @Date 2019/8/10 10:01
 * @Description  用户角色类
 * @Version 1.0
 **/
public class UserRole {
    
    public String id;  //用户id
    public String name;  //用户名称
    public String passward;  //用户密码
    public String roleName;  //用户角色名称
    
  /**
   * @Author
   * @Description 用户登录
   * @Date 2019/8/10 10:11
   * @Param name表示用户名 passward表示密码
   * @return
   **/
    public void userLogin(String name, String passward){
        /*
        这是用户登录的具体实现
        请严格验证。。。
         */
        System.out.println("用户登录。。。。。。。");
    }
}

以上代码为例子。

1、命名注意事项：

关键字class后面紧跟类名；

类名必须以字母开头，后面可以跟字母与数字的任意组合，但是不能使用java保留字；（最基本的条件）

标准的命名规范要求：类名是以大写字母开头的名词，如果名字由多个单词组成，那么每个单词的首字母要大写，如以上例子的类名UserRole；

源文件名必须与公共类名字相同，并以.java作为扩展名;

方法的命名与类名的命名类似，不过首字母要求小写；

常量命名全用大写，变量命名与方法名类似

2、注释：

//    表示单行注释

/*  */  表示多行注释

/**    */  表示文档注释   主要用于api的生成