注释

。单行注释 //

。多行注释 /*  */

。文档注释/**   */

       。。如果编写了Java源代码时添加了合适的文档注释,然后通过JDK提供的Java动词工具可以直接将源代码里的文档注释提取成一份系统的API文档

。API文档

 。。在多人开发的过程中,不同的人定义了不同的类,其中包括不同的长远变量和方法。则有必要提供一份说明文档

。。API(应用程序接口)文档说明每个类、每个方法的功能以及用法

。。通过javadoc工具生成API文档

。常用javadoc标记

       。。@author

       。。@version

       。。@deprecated-不推荐使用的方法

       。。@param

       。。@return

       。。@see-“参见”,指定较差参考的内容

       。。@exception-抛出异常类型

       。。throws-抛出的异常,同exception

       。。出现在类/接口文档中的有:@see、@deprecated、@author、@version

       。。出现在方法或构造器文档注释中的有:@see、@deprecated、@param、@return、throws、@exception

       。。出现在成员变量的文档注释中有:@see、@deprecated

posted @ 2018-05-22 11:31  Demetris  阅读(114)  评论(0编辑  收藏  举报