java 注释(comment) 学习笔记

java yekong 107℃

介绍

用于注解说明解释程序的文字就是注释,注释提高了代码的阅读性(可读性),注释
是一个程序员心须要具有的良好编程习惯。将自己的思想通过注释先整理出来,再用
代码去体现。

Java中的注释类型

  1. 单行注释
  2. 多行注释
  3. 文档注释

单行注释

基本格式
格式://注释文字

多行注释:

基本格式
格式: /* 注释文字 */

使用细节
1)被注释的文字,不会被JVM (ava虚拟机)解释执行
2)多行注释里面不允许有多行注释嵌套

文档注释

注释内容可以被JDK提供的工具 javadoc 所解析,生成一套以网页文件形式体观的该
程序的说明文档,一般写在类
基本格式
如何生成对应的文档注释
应用实例

/**
 * @author yekong
 * @version 0.1
 *
 * */
public class ChangeChar {
    public static void main(String[] args) {
        System.out.println("书名\t作者\t价格\t销量\n三国\t罗贯中\t120\t1000\n");
    }
}

javadoc -d 路径 -author -version ChangeChar.java
喜欢 (0)