Appearance
用于解释代码思路、程序的文字我们称之为注释,目的为了让代码的可读性更强;Java的注释只会出现在源码文件中,编译后的文件,是不会出现任何注释相关的内容;因此注释不会对代码的执行产生任何的影响;
写好注释,也是优秀程序员的必备素养;常用的注释有三种:
Java 中使用 // 进行行注释,//之后到行末尾,就是注释的内容
//
// 这是一段行注释,下面这行代码的作用是在控制台输出:hello world! System.out.println("hello world!");
上面介绍的单行注释,只能作用到行末尾;但有时候,我们需要将一整片的代码、描述注释掉,因此就需要用到多行注释,避免需要逐行进行注释;
使用/*开头,*/结尾,包含在他们中间的内容全部属于注释内容;
/*
*/
/* 这里面包裹的 就是要多行注释 的内容 */
使用/**开头,*/结尾的注释成之为文档注释,文档注释被JDK提供的工具 Javadoc 所解析,生成一套以网页文件形式体检的说明文档;
/**
/** * 这是一段块注释 * @author 一行Java * @title: HelloJava * @projectName Java-ehang * @description: TODO 第一个Java 程序 * @date 2022/9/13 22:13 */ public class HelloJava { public static void main(String[] args) { System.out.println("hello world!"); } /** * 加法元素 * @author 一航 * @param a 参数一 * @param b 参数二 * @return 相加的结果 */ public static int add(Integer a, Integer b) { return a + b; } }
生成文档:
javadoc -d doc -encoding UTF-8 -charset UTF-8 HelloJava.java
-d
-encoding
-charset
HelloJava.java
注释
用于解释代码思路、程序的文字我们称之为注释,目的为了让代码的可读性更强;Java的注释只会出现在源码文件中,编译后的文件,是不会出现任何注释相关的内容;因此注释不会对代码的执行产生任何的影响;
写好注释,也是优秀程序员的必备素养;常用的注释有三种:
单注释
Java 中使用
//
进行行注释,//
之后到行末尾,就是注释的内容2
多行注释
上面介绍的单行注释,只能作用到行末尾;但有时候,我们需要将一整片的代码、描述注释掉,因此就需要用到多行注释,避免需要逐行进行注释;
使用
/*
开头,*/
结尾,包含在他们中间的内容全部属于注释内容;2
3
4
5
文档注释
使用
/**
开头,*/
结尾的注释成之为文档注释,文档注释被JDK提供的工具 Javadoc 所解析,生成一套以网页文件形式体检的说明文档;2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
生成文档:
-d
用来指定输出目录-encoding
编码格式-charset
字符集HelloJava.java
源文件名称