Java基础语法—注释、标识符

注释

public class Demo1 {
    //单行注释

    /*
    多行注释
     */

    /**
     * 文本注释
     */

}

JavaDoc

javadoc命令是用来生成自己API文档的

参数信息：

• @author 作者名
• @version 版本号
• @since 指明需要最早使用的jdk版本
• @param 参数名
• @return 返回值情况
• @throws 异常抛出情况

package com.cheng.opretor;

/**
 * @author suncheng
 * @version 1.0
 * @since 1.8
 */

public class Doc {
    String name;

    /**
     * @author
     * @param name
     * @return
     * @throws Exception
     */

    public String test(String name) throws Exception{
        return name;
    }
}

生成JavaDoc文档方法：

• 通过命令行

  ​ 编写dac文件，在doc.java目录下进入cmd,输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java

• 通过IDEA

  • 打开想创建的类

  • Tools->Generate JavaDoc->配置各种参数

    local:zh_CN

    orther command:-encoding UTF-8 -charset UTF-8

  • 查看生成文档

标识符

1. 类名、变量名以及方法名都会成为标识符。

2. 所有标识符都是以字母、$、_开头。

3. 首字母之后可以是字母、$、_、数字的任意字符。

4. 标识符不能用类名或方法名。

5. 标识符是大小写敏感的

6. 可以用中文或者拼音命名，但不建议，很low。

   public class Demo1 {
       public static void main(String[] args) {
           
           String a = "1";
           String $a = "1";
           String _a = "1";
           String A1 = "1";
           String $_123 = "1";
           String man = "1";
           String Man = "1"; 
           
       }
   }