05※、API文档的注释的使用

    ※API文档的注释的使用

    注释的作用：提高代码的可读性,被注释的代码不会被编译器所编译

    注意:多写注解 一定要注意空格  

    --单行注释

            //   

    --多行注释

            /*   */

    --文档注释：生成API帮助文档

            /**   */

API文档:

  --生成api文档的命令

            javadoc -d api生成的存放目录 Java源文件

            eg:C:\Users\Lantzrung\Desktop\demo1>javadoc -d C:\Users\Lantzrung\Desktop\demo1 Hello.java

注意：如果要生成API，作者以及版本信息的话，则需要指定author和version 生成API文档别的命令基本不需要在cmd命令中加入

            javadoc -d api生成的存放目录 -author -version Java源文件

注意：如果属性或者方法不是public修饰的，则需要在命令中加上-private私有参数

           eg:C:\> 所要文件的绝对路径 -author -version -private Demo.java

注意:document(文件夹名称)用于存放api文件，要查看API文档网址要打开源文件.html。

API中默认生成public和protected修饰的方法 default和private是不生成的

【可以通过参数进行设置生成 -private】

/**
  *
  * @Author Lantzrung
  * @Date 2022年7月16日下午4:44:42
  *  
**/
/**  
 这是Demo程序
 @author Lantzrung
 @version 1.8jdk
*/
public class Demo{
 public static void main(String[] args){
   //这是一个整形的变量,用于实现计数
   //int count = 10;
 }
 //定义一个方法【这是一个过时方法】
 /**
  * 这是一个过时的方法
  * @deprecated
  */
  public void test(){
}
  /**
   * 两数相加的方法
   * @param a 是一个int类型的变量
   * @param b 是一个double类型的变量
   * @return 返回值是两数之和，结果类型是double
   * @return 返回值是两数之和，结果类型是double
   * @see <a href ="http://www.baidu.com">参考度娘</a>
   */
  public double add(int a,double b){
    return a+b;
}
  //API中默认生成public和protected修饰的方法  default和private是不生成的【可以通过参数进行设置生成 -private】
  /**
   * 异常测试的方法
   * @throws Exception 描述异常抛出的声明类型 testException方法抛出了这个异常 [声明]
   * @exception Exception 描述异常抛出的动作 testException方法抛出了这个异常 [动作]
   */
  public void testException() throws Exception{
}
  //API中默认生成public和protected修饰的方法  default和private是不生成的【可以通过参数进行设置生成 -private】
  /**
   * 异常测试的方法
   * @throws Exception 描述异常抛出的声明类型 testException方法抛出了这个异常 [声明]
   * @exception Exception 描述异常抛出的动作 testException方法抛出了这个异常  [动作]
   */
  private void test1Exception() throws Exception{//此为私有方法故，要在cmd中 -private故此才能输出  
  }

}