Java 文档&注释 -Java学习笔记（32）

 一段好的程序应该是易读的，并且有明了的文档。
和C语系的其他大部分语言（C++，C#）一样，Java支持两种注释：
1。/*  和 */  注释一段代码
2。//  注释一行代码

Java中文档和源程序写在一起，用javadoc可以命令生成文档，这里自动生成的文档样式和sun的JDK文档是一样的。非常好用。这样程序会更加易读，并且修改更方便。
文档以 /** 开始，以*/结尾，习惯上在每行开头都加上一个 *  文档有其特有的标记：
@param 参数名 参数描述
@return 返回值描述
@throws 抛出异常
@deprecated 建议不要使用的
@version 版本
@author 作者信息
在C#中，文档则是由///和XML标记组成的。文档在多数IDE中都有很好的支持，标记由IDE中自动填充

程序开始//:  后跟文件完整路径和文件名,并且以///:~结尾。

//: DocTest.java
import java.util.*;

 /**
 * Java document test.
 * Display current date.
 * @author ZhaoHongliang
 * @author http://blog.youkuaiyun.com/nyzhl/
 * @version 1.0
 */
public class DocTest ...{
    /**
     * Entry point of application.
     * @param args Command string array.
     * @throws None.
     */
    public static void main (String[] args) ...{
        System.out.println(new Date());
    }
}
///:~