Java Doc

JDK帮助文档

 

https://docs.oracle.com/javase/8/docs/api/

 

Java Doc

 

*参数信息

@ author 作者名

@ version 版本号

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

@ param 参数名

@ return 返回值

@ throw 异常抛出情况

 

 package com.xiatiandesuyan.base;
 ​
 /**
  * @author  Xiatiandesuyan
  * @version  1.0
  * @since  1.8
  */
 public class Doc {
 ​
     String name;       //属性
 ​
     /**
      * @author Xiatiandesuyan
      * @param name
      * @return
      * @throws Exception
      */
     public  String test (String name) throws  Exception{
         return name ;     //方法
     }
     // 我是通过命令行     javadoc    参数    Java文件
     
     //作业： 学会查找使用IDEA生产JavaDoc文档！        面向百度编程
     
 }
 ​