注释

注释：注释起到对代码标注和解释的作用，如果你去看看JDK源码，会发现他们有许多的注释，而且注释是比代码还要多的，可见为代码添加注释是非常重要的，写好注释能让别人更加容易看懂你的代码，注释可以分为以下三种。

1. 单行注释

   // 注释内容
   

2. 多行注释

   /*注释
   内容*/
   

3. 文档注释

文档注释主要是用来生成java开发文档javadoc的，生成的开发文档和Java本身的API帮助文档是一样的，也就是对你所写的类进行解释说明，所以它还需要搭配一些文档标记，进行解释说明，而且在文档注释中可以使用HTML语言，jdk源码中有大量的文档注释，所以弄懂文档注释可以帮助你更好的看懂源码。

文档注释使用方法：

/**
	* @标签名 xxx
	* @标签名 xxx
*/

javadoc工具命令

javadoc -d 存储生成注释文档的路径 -标签 -标签 xxx.java

就文档注释写好后需要用javadoc工具根据.java的文件生成注释文件

生成后点开其中的 index.html即可

javadoc的常用标签

在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。

之后，你可以包含一个或多个各种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该放成一组。

举例：

/**
 * 表层数据库访问
 */
public interface OrderInterface {
    /**
     * 获取全部订单
     * @param a 起始位置
     * @param b 末位置
     * @return 列表？
     */
    List<Orders> pageList(int a, int b);

    /**
     * 获取全部行数
     * @return int
     */
    int pageCount();

    /**
     * 通过ID查询订单
     * @param id 订单号
     */
    List<Orders> pageListById(int id);

    /**
     * 通过日期时间查询订单
     * @param d1 起始时间
     * @param d2 截止时间
     */
    List<Orders> pageListDate(String d1, String d2);

    /**
     * 通过menu查询订单
     * @param name ？
     */
    List<Orders> pageListMenu(String name);

    /**
     * 通过id更新delivery
     * @param id
     * @return
     */
    int updateDeliveryById(Integer id);

    /**
     * 通过ID删除订单
     * @param id 订单ID
     */
    int deleteById(Integer id);

    /**
     * 通过delivery查询订单
     * @param delivery ？
     */
    List<Orders> pageListByDelivery(Integer delivery);

    int insert(Orders orders); // 增加order
}

原文地址：http://www.cnblogs.com/wdadwa/p/java_learning_02.html