【大数据】学习笔记 1 Java SE 第2章 Java基础语法 2.1 注释(annotation)(掌握)

柔情只为你懂 2024-03-22 09:16 48阅读 0赞

### 【大数据】学习笔记 ###

#### 文章目录 ####

*   *  【大数据】学习笔记
     *   *  1 Java SE
         *   *  第2章 Java基础语法
             *   *  2.1 注释(annotation)(掌握)

![在这里插入图片描述][c8119afff42a4bcca5f1f3d1822ce76a.png_pic_center]

#### 1 Java SE ####

##### 第2章 Java基础语法 #####

###### 2.1 注释(annotation)(掌握) ######

*  **注释**：就是对代码的解释和说明。其目的是让人们能够更加轻松地了解代码。为代码添加注释，是十分必须要的，它不影响程序的编译和运行。
 *  Java中有`单行注释`、`多行注释`和`文档注释`
    
     *  单行注释以 `//`开头，以`换行`结束，格式如下：
        
            // 注释内容
     *  多行注释以 `/*`开头，以`*/`结束，格式如下：
        
            /*
            	注释内容
             */
     *  文档注释以`/**`开头，以`*/`结束，Java特有的注释，结合
        
            /**
            	注释内容
             */

//单行注释
    /*
    多行注释
    */
    /**
    文档注释演示
    @author Ding Jiaxiong
    */
    public class Comments{
        
        
    	/**
    	Java程序的入口
    	@param String[] args main方法的命令参数
    	*/
        public static void main(String[] args){
        
            System.out.println("hello");
        }
    }

![在这里插入图片描述][7ae0669b9bd94fc9a9b9e5b5c4774de4.png_pic_center]

![在这里插入图片描述][7a9ba6f62eb04890b854d858d64edfe7.png_pic_center]

常见的几个注释：

*  @author 标明开发该类模块的作者，多个作者之间使用,分割

*  @version 标明该类模块的版本
 *  @see 参考转向，也就是相关主题
 *  @since 从哪个版本开始增加的
 *  @param 对方法中某参数的说明，如果没有参数就不能写（后面再学）
 *  @return 对方法返回值的说明，如果方法的返回值类型是void就不能写（后面再学）
 *  @throws/@exception 对方法可能抛出的异常进行说明 ，如果方法没有用throws显式抛出的异常就不能写（后面再学）

其中 @param @return 和 @exception 这三个标记都是只用于方法的。

*  @param的格式要求：@param 形参名 形参类型 形参说明
 *  @return 的格式要求：@return 返回值类型 返回值说明
 *  @exception 的格式要求：@exception 异常类型 异常说明
 *  @param和@exception可以并列多个

使用javadoc工具可以基于文档注释生成API文档。

用法: javadoc [options] [packagenames] [sourcefiles] [@files]

例如：

javadoc -author -d doc Comments.java

![在这里插入图片描述][e0d16a4308764bfeb9704344a9de0a12.png_pic_center]

运行命令

![在这里插入图片描述][9b78d5719483455d804b642e263703d0.png_pic_center]

OK，看看有啥

![在这里插入图片描述][d5bf5dd41d23456f8907401bbca27b49.png_pic_center]

打开`index.html`

![在这里插入图片描述][20c2b49dc13b45858695c920732f5a7c.png_pic_center]

没问题。

[c8119afff42a4bcca5f1f3d1822ce76a.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/eaf890fe4b9249b1b987a0c2f5b42cd2.png
[7ae0669b9bd94fc9a9b9e5b5c4774de4.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/cd532bdcbf40427280dfdd765aaa14ca.png
[7a9ba6f62eb04890b854d858d64edfe7.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/c8094dfdc3144738a2b459ca1a050a2a.png
[e0d16a4308764bfeb9704344a9de0a12.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/7d225d35b1554618860119de13a0e0f0.png
[9b78d5719483455d804b642e263703d0.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/6f7324ffabe544929b20bbcc235d29d5.png
[d5bf5dd41d23456f8907401bbca27b49.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/772eb6bb0aa748d4961b35f7037eeee7.png
[20c2b49dc13b45858695c920732f5a7c.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/55962d81a8734af48b0ef866c0151cde.png