java注释和javaDoc文档运用

编译型和解释型

编译型：操作 c/c++
解释型：网页 java

注释如何运用

注释并不会执行，是给我们写代码的人看。

• 单行注释：//
• 多行注释: /* 注释 */
• Javadoc：文档注释 /** */

package com.kuang.base;

public class Helloworld {
    public static void main(String[] args) {
        //我是单行注释（只能注释一行文字）
        //请输入一个Hello,World!
        /*
        我是多行注释  （可以注释一段文字）
         */
        System.out.println("Hello,World!");
        /**   Javadoc:文档注释
         * @Description Hello,World
         */
    }
}

Javadoc生成文档

javadoc命令是用来生成自己的API文档的。
参数信息：

• @author 作者名
• @version 版本号
• @since 指明需要最早使用的jdk版本
• @param 参数名
• @return 返回值情况
• @异常抛出情况

package com.kuang.base;

/**
 * @author gaochengcai
 * @version 1.0
 */
public class Doc {
    String name;

    /**
     * @author gaochengcai
      * @param name
     * @return
     * @throws Exception
     */
    public String test(String name)throws Exception{
        return name;
    }
}

学会查找使用IDEA生产javadoc文档：面向百度编程

项目->右键->点击Open in->点击Explorer

输入cmd打开

输入：javadoc -encoding UTF-8 -charset UTF-8 Doc.java

我们就可以看到文件夹生成了许多东西，然后点击index.html就可以查看了