Java学习04-注释


注释

Java规范的三种注释方式:单行注释、多行注释、文档注释

  • 单行注释

    // 单行注释:只能注释一行文字	//
    
  • 多行注释

    // 多行注释:可以注释一段文字     /*  注释   */
    /*
    我是多行注释
    我是多行注释
    我是多行注释
    我是多行注释
    */
    
  • 文档注释

    // JavaDoc:文档注释 /**    */
    /**
     * @version V1.0
     * @author 指定Java程序作者
     */
    

示例代码:


/*
1. java规范的三种注释方式
单行注释
多行注释
文档注释

2. 
单行注释和多行注释的作用:
① 对所写的程序进行说明,增强可读性。方便自己,方便别人
② 调试所写的代码

3. 特点:单行注释和多行注释,注释了的内容不参与编译
		 换句话说,编译后生成的.class结尾的字节码文件中不包含注释掉的信息

4. 文档注释的使用:
	注释内容可以被JDK提供的工具 javadoc 所解析,生成一套以网页文件形式体现的该程序的说明文档。

5. 多行注释不可以嵌套使用

*/

/**
文档注释
@author Brian
@version v1.0
这是我的第一个Java程序!非常的开森!

*/


public class HelloJava {
	/*
	多行注释:如下的main方法是程序的入口!
	main的格式是固定的!
	*/
	/**
	如下的方式是main(),作用:程序的入口。
	*/

	public static void main(String[] args) {
		// 单行注释:如下的语句表示输出到控制台
		System.out.println("Hello World!");
	}
}


文档注释的操作方式

image-20210423173233958

然后就会生成一个对应的myHello文件夹(文件名可自定义)

image-20210423173349805

文件夹里的index.html就是所编写说明文档的首页

image-20210423173543806


image-20210423173611682

posted @ 2021-04-23 17:38  Brianxq  阅读(80)  评论(0)    收藏  举报