Java学习笔记

package com.klsstt.test;

/**
 * @author klsstt
 * @version v0.1
 * 我是文档注释
 */
public class HelloWrod {
    /**
     * 这是main方法
     * @param args 默认参数
     */
    /*
        我是多行注释
     */
    public static void main(String[] args) {
        /*
        我也是多行注释
        */
        //我是单行注释
        //System.out.println("我是单行注释!");
        System.out.println("Hello Word!");
    }
}

我在main方法中，注释了一行代码，如果注释无效，代码会在程序编译之后运行并输出“我是单行注释!”，之后会输出“Hello Word!”，运行该程序观察结果。

控制台中只输出了“Hello Word!”，证明我们这行代码在被编译器翻译的过程中被忽略了。

单行注释

顾名思义，对单行进行的注释，以//开始，也可以用来对某一行代码进行注释。
被注释的代码在编译过程中会被忽略，例如上述案例中的 //System.out.println("我是单行注释!");，我们通常使用单行注释对某一行的代码、变量具备的业务内容进行说明。

多行注释

/*开始，*/结束为多行注释，在多行注释中，可以输入多行内容，但是内容中不能嵌套多行注释，负责编译器会报错。

编译器只能识别第一个/*和第一个*/的符号，就会认为注释结束，如果后面还有注释则认为是错误代码。
错误示范：/* /* 嵌套注释 */ */

文档注释

/**开始，*/结束，文档注释就比多行注释开头多了一个*，但是与多行注释作用完全不同。

文档注释是可以被JDK提供的javadoc工具所识别的一种注释，按照规定的要求进行书写的文档注释可以使用javadoc工具生成一套HTML版本的说明文档。

javadoc.exe在JDK的bin目了下，可以使用命令行javadoc -d 文件夹名称 作者 文件路径生成html说明文档。

在IDEA中如何生成javadoc说明文档呢，打开工具栏Tools->Generate JavaDoc

打开之后，会弹出JavaDoc配置窗口，配置内容如下

注意：使用了注解@author和@version需要在配置中勾选，否则生成的文档中不会携带对应的信息，我这里截图是未勾选的情况。

参数说明：

• Generate JavaDoc scope
  选择生成的文档范围，可以对整个工程生成javadoc，也可以针对某一个文件，一个模块进行，这个根据实际工作情况来定，我们这块只需要选择HelloWord.java这个文件即可。
• Locale
  语言选项，国内就填写zh_CN即可。
• Other command line arguments
  其他参数选项，主要用来设置编译文件的编码

  -encoding UTF-8 -charset UTF-8 
  

配置完成之后选择好输出路径，点击OK即可弹出生成好的文档页面。

点击HelloWord，即可看到类与方法的文档内容描述

被我用红圈圈起来的地方就是我们的文档注释内容，我们再来看看这段代码

 /**
     * 这是main方法
     * @param args 默认参数
     */
    /*
        我是多行注释
     */
    public static void main(String[] args) {
        /*
        我也是多行注释
        */
        //我是单行注释
        //System.out.println("我是单行注释!");
        System.out.println("Hello Word!");
    }