黑马程序员技术交流社区

标题: java文档注释细节 [打印本页]

---

作者: 鲍霄霄    时间: 2012-7-14 08:43
标题: java文档注释细节
java中还有一种注释方式：/**  */这种方式用于生成java文档，用户可以使用javadoc命令，
为自己些出的代码生出html格式的代码使用说明，生成的代码格式同java文档一样。注释范例如下。
/**
*如果用户已登录则跳转到主页，否则跳转到登录页面
*/
public boolean logon(String[] user){
//程序逻辑代码
}
“如果用户已登录则跳转到主页，否则跳转到登录页面”便是logon的注释，它注明了这个方法所实现的功能。针对这行代码执行javadoc命令会生成一段java文档。
boolean Test1.logon（String user）；
?注意：javadoc只能为public 和protected 成员注释文档，private 和 “友好”成员注释会被忽略。
这是当然的，因为java文档是提供第三方程序员查阅的，文档的提供可以很好的提供隐藏一些代码细节，不被这些程序员知道，
  java提供的了注释标签使javadoc命令可以以模板的方式生成java文档，这些注释标签可以分为类文档标记（用于类文档的信息标记，作者，版号等），
方法文档标记（用于标明方法的参数的含义，返回值含义等）异常标记，API作废标记等等
@param 用于标注参数含义，标注完成后在如ECLIPSE这类的IDE中，如果调用了被标注的方法，鼠标指出的地方就会出现参数的含义
@version 用于标记版本号，如果在javadoc中使用就会在自动HTML文档中提取信息。
@author 用于标一些基本的信息，如：作者等，如果在javadoc中使用就会在自动HTML文档中提取信息
@return  标签用于标注返回值含义


package bxx;
/**
*  javadoc 注释测试程序
*  @author
*  @see java.lang.String
*  @version 1.0
*/
public class JavaDocTest{
/**
*  javadoc JavaDoc测试方法
*  @param I 第一个参数
*   @param J 第二个参数
*  @return  返回值为1
*/
public int test （int i，int j）{
        return 1
{
}


使用命令行运行出来所生成的java文档标示：
bxx;
class JavaDocTest
java.lang.Object
bxx.JavaDocTest
public class JavaDocTest
extends java.lang.Object
javadoc注释测试程序
See Also
java.lang.String
@author
bxx
@version
1.0

---

欢迎光临 黑马程序员技术交流社区 (http://bbs.itheima.com/)

黑马程序员IT技术论坛 X3.2