文档注释

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

  • 参数信息

    • @author 作者名

    • @version 版本号

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

    • @param 参数名

    • @return 返回值情况

    • @throws 异常抛出情况

  • 加在类上面就是类的注释,加在方法上面就是方法的注释

package zjystudy.com.operator;

/**
* @author 二狗子
* @version 1.0
* @since 1.8
*/
public class Dome11 {
   String name;//它是一个属性
   //它是一个方法

   /**
    *
    * @param name
    * @return
    * @throws Exception
    */
   public String test(String name) throws Exception {
       return name;
  }
   public static void main(String[] args) {

  }
}

生成.doc帮助文档dos版

 

生成.doc帮助文档IDEA版

 

posted @ 2020-10-04 14:17  0基础学Java  阅读(98)  评论(0)    收藏  举报