Java基础语法01 --》 注释，标识符，关键字

Java基础语法01 --》 注释，标识符，关键字

---

1、注释，标识符，关键字

注释

Java中的注释有三种：

• 单行注释 //

• 多行注释 /* */

• 文档注释 /** * */

  示例：

public class Hello {
    //这是一条单行注释
    
    /*
        这是一条多行注释
     */

    /**
     * 
     * @author zhang
     * @version 1.0
     */
    
    public static void main(String[] args) {
        System.out.println("Hello,World!");
    }
}

注意事项：

• 在Java中 /* */ 注释不能嵌套

  我们看一下就知道为什么不能实现嵌套了

可以看到java自动识别上一个多行注释的末尾作为结束，把中间嵌套的多行注释的开头给当做了注释

此外，我在这里对文档注释进行详细介绍。

文档注释

这里是对文档的注释的详解，初学者看不懂也没有关系，可以跟着做一遍，以后再详细的理解。

文档注释负责描述类、接口、方法、构造器、成员字段。可以被JDK提供的工具Javadoc所解析，自动生成一套以网页文件形式体现的该程序说明文档的注释。

注意：文档注释必须写在类、接口、方法、构造器、成员字段前面，写在其他位置无效。

格式：

/**
* 对于类、接口和方法的描述
*  @ 标签
*  @ 标签
* 
*/

常用的标签如下：

接下来我将用两种方法生成程序文档：

我们用下面这段代码作为示例

这里的代码应用了后面类与对象的知识，看不懂没关系，这里只是作为一个案例。

public class Cat {

    String color;

    public void getColor(){
        System.out.println("小猫的颜色是："+color);
    }

    public void setColor(String color){
        this.color = color;
    }

    public void eatFood()
    {
        System.out.println("小猫吃鱼");
    }

    public void meowth()
    {
        System.out.println("小猫喵喵叫");
    }

    public static void main(String[] args) {
        Cat cat = new Cat();
        cat.setColor("橘黄色");
        cat.getColor();
        cat.meowth();
        cat.eatFood();
    }
}

---

1、使用javadoc生成文档

1. 我们首先找到Cat.java所在的路径

2. 我们在路径前面加上cmd 打开控制台。

   ​ 例：cmd E:\IDEA workspace\Demo1\src\com\zhang\base

3. 

   执行如上命令

   为防止产生乱码，我们在Javadoc命令后加上-encoding UTF-8 -charset UTF-8

4.

我们可以看到相比于之前多了很多东西

5. 在当前目录下进入index.html

6. 
   

   以上就是使用javadoc命令生成程序文档的步骤。

   ---

   2、第二种我们使用IDEA生产文档

   1.菜单栏–>Tools–>Generate JavaDoc

2.我们只将当前这个Cat.Java生成api文档，选择好存放的位置，然后点击OK就好了。

​ 3.但是我们在javadoc的过程中出现了问题，这都是因为字符的编码有问题，导致了乱码。

​

​ 4.我们只需要进行如下操作就可以正常的生成api文档了

5.点击OK我们去我们存放文件的位置找一下文档
6.

​ 7.

以上两种生成java文档的方法就介绍到这里了，我们接着介绍下面的内容。

---

标识符

Java左右的组成部分都需要名字，类名、变量名、以及方法名都别成为标识符。

关键字

​ 以上是java的一些关键字，我们知道有哪些东西就好，这里不做赘述，以后我们都会学到。

标识符的命名规则

• 所有的标识符都应该以字母（A-Z或a-z），美元符（$）,或者下划线（_）开始
• 首字符之后可以是字母（A-Z或a-z），美元符（$）,或者下划线（_）或数字的任何字符组合
• 不能使用关乎尖子作为变量名或方法名
• 标识符是大小写敏感的
• 合法标识符的举例：age ，$salary ,_value , _1_value , Name
• 非法标识符举例： 123abc ， - salary ，#abc