小侃Java注释

    与大多数的编程语言一样，Java也有自己代码注释的标准与规则。注释的好处不消多说，良好的代码注释更有利于项目管理，以及项目交接等。

    Java中的注释方法大致分为三种：

    1、单行注释：

    很容易理解单行注释的作用，肯定是某一特定行的代码注释，指明该行代码的作用。单行代码的注释是以"//"开头的，如下所示：

    //该函数只起示例作用，没有什么特殊的含义

    public void test(){

    }

    单行注释在编译的时候是被忽略的。

    2、多行注释：

    当然，多行注释是为了注释某一代码块的作用的，一般而言为多行代码！多行注释是以结束，这两个符号之间的所有内容将被编译器所忽视，如下所示：

    /*

      Author:Royen

      Date:XX年XX月XX日 

    */ 

    public class Demo{

        public int sum( int a, int b){

             return a+b;

        }

    }

    3、文档注释:

    文档注释是以结束。为什么会多出来这一种注释呢？文档注释的好处在于方便生成项目的文档，以便使用者进行查阅。至于生成方法嘛，我们可以使用Java的文件生成工具Javadoc直接将源文件生成对应的文档(Javadoc是JDK提供的一个命令行工具，用以生成HTML格式的帮助文档)，如果先单文件生成很烦的话，一些集成开发工具提供文档生成功能也很不错哦！

    /**

     * Author: Royen

     * Date: XX年XX月XX日

     */   

    public class Demo{

        public int sum( int a, int b){

             return a+b;

        }