javadoc基本注解

IO_oI

转载自http://blog.sina.com.cn/s/blog_5138efc30100o8bm.html
[size=large]
一些参数说明如下所示：
@see 生成文档中的“参见xx 的条目”的超链接，后边可以加上：“类名”、“完整类名”、“完整类名#方法”。    可用于：类、方法、变量注释。
@param 参数的说明。    可用于：方法注释。
@return 返回值的说明。    可用于：方法注释。
@exception 可能抛出异常的说明。    可用于：方法注释。
@deprecated 声明该功能已由改进过的新功能取代，建议用户不再使用，将来新版本可能摒弃这一功能。
@version 版本信息。    可用于：类注释。
@author 作者名。    可用于：类注释。
/*javadoc注解文字换行：<br/>*//***@return next<br/>*line*/
javadoc是用来在JAVA程序的开发过程中根据特定格式的注释进行程序文档整理的工具，可以生成规范的HTML文件格式API说明手册。
javadoc默认为public、protected两种权限的类成员变量及方法进行处理注释文档，可以使用-private参数进行对private权限的类成员变量及方法生成注释文档。可以在注释内容中嵌入HTML标记丰富生成后文档的显示。
javadoc注释有三种类型: 类注释、方法注释、变量注释。

对类的行为编制文档远远不只是对每个方法做什么给出一行描述。有效的 Javadoc 应该包括对下列内容的描述：
    类如何相互关联
    方法如何影响对象的状态
    方法如何将出错条件通知它们的调用者以及它们可能通知什么错误
    类如何处理多线程应用程序中的使用
    方法的参数作用域及其返回值的范围