Java基础——(1) 注释

注释

​刚学习Java的时候对注释也是不屑一顾，觉得实现功能才是最重要的。直到后面项目越做越多，代码越敲越多，回头再看自己写的代码也稍显吃力，注释就显得尤为重要了。虽然它与实现功能无关，但是在学习中对自己日后复习代码十分重要，在工作中也便于他人阅读来协作，所以还是要养成编写注释的良好习惯。

Java中有三种注释：

• 单行注释：// 注释内容

• 多行注释：/* 注释内容 */

• 文档注释：

  /**
  
   *
  
   *@author			作者信息
  
   *@version			版本信息
  		
   *@since			标记当引入一个特定的变化时
  
   *@param			方法参数
  
   *@return			返回值类型
  
   *@throws			标志一个类抛出的异常同@exception
  
   *...
  
   */
  

  示例：

  /**
   * @author LEO
   * @version 1.0
   * @since jdk1.8
   *
   */
  public class Doc {
  
      String name;
  
      /**
       *
       * @param name
       * @return String
       */
      public String getName(String name){
          return name;
      }
  
  }
  

  编写好代码后，去到代码所在目录
  

也可以当前目录Shift加右键，或进入cmd后cd跳转到目录…

javadoc会提取代码中的文档注释，生成Java API帮助文档。
在大型项目中，需要编写帮助文档与阅读他人的帮助文档，以便于分工合作。