day13-JavaDoc

JavaDoc

• JavaDoc命令是用来生成自己API文档的

• 参数信息

  • @author 作者名

  • @version 版本号

  • @since 指明需要最早使用的jdk版本

  • @param 参数名

  • @return 返回值情况

  • @throws 异常抛出情况

     package com.dlq.base;
     ​
     /**
      * @author dlq
      * @version 1.0
      * @since 1.8
      */
     ​
     //加在类上面就是类的注释
     ​
     public class Doc {
         String name;
     ​
         /**
          * @author dlq
          * @param name
          * @return
          * @throws Exception
          */
         //加在方法上面就方法的注释
     ​
     ​
         public String test(String name) throws Exception{
             return name;
         }
             //命令行     javadoc  参数  java文件
     ​
             //使用IDEA生产JavaDoc文档！     面向百度编程！
     ​
             //基础部分的一切知识，后面都会用到，要好好研究，好好熟悉！！！
     }
     ​

    • 鼠标右键点击Doc.java这个文件，向下找到Show in Explorer(打开于Explorer)

    

    • 然后在打开的文件夹路径前加上cmd进入命令提示符，输入以下字符

    

    • 再返回文件夹打开index.html，即生成的文档

    

  基础部分的一切知识，后面都会用到，要好好研究，好好熟悉！！！

  使用IDEA创建JavaDoc文档！

  1. 找到tools(工具)里面的Generate(生成) JavaDoc

  

  1. 在弹出界面模仿如下修改操作

  

  -encoding UTF-8 -charset UTF-8

  3.点击确定，等待idea生成javaDoc即可