A股上市公司传智教育(股票代码 003032)旗下技术交流社区北京昌平校区

 找回密码
 加入黑马

QQ登录

只需一步,快速开始

© 伊文龙 中级黑马   /  2012-4-19 19:40  /  1881 人查看  /  5 人回复  /   0 人收藏 转载请遵从CC协议 禁止商业使用本文

文档注释是java特有的注释方式,可以通过javadoc.exe将注释中的内容抽取出来做成html文档
但是具体应该怎么抽取,命令应该怎么写啊

5 个回复

正序浏览
/**
* 这是一个说明java文档写作的类。
* @author user
*
*/
public class Demo{
   public static void main(String[] args){
         Demo.show();
   }
   /**
    * static show()方法用来输出“java注释!”字符串。
    */
  public static void show(){
      System.out.println("java注释!");
}
}
例如上面的代码:
文档注释的格式是: /**
    * static show()方法用来输出“java注释!”字符串。
    */
编译生成文档的命令是:javadoc -d documentName -author
其中javadoc是编译的开头命令,-d是生成的文档的保存路径,documentName是你给你生成的文档起的名字,例如Myhelp,这里用的是当前路径,也可以用绝对路径如C:\Myhelp。-author是指要求生成的文档要包含author的名字。
回复 使用道具 举报
liuyang 发表于 2012-4-19 20:22
1. 将java文件(名字JavadocDemo.java)放置在某一目录,如:"D:/doc";

2. 运行cmd,进入该目录,执行“jav ...

可不可以一次生成多个类的文档?
比如说,把java源文件的文档能通过这种方式搞出来吗?
回复 使用道具 举报
只能从相应的JDK中取得,安装后在bin目录下。具体 * Javadoc 1.4 is included in Java 2 SDK, Standard Edition v 1.4 * Javadoc 1.3 is included in Java 2 SDK, Standard Edition v 1.3 * Javadoc 1.2 is included in Java 2 SDK, Standard Edition v 1.2 * Javadoc 1.1 is included in JDK 1.1 Java平台API文档由源码中的文档注释定义,且任何此类文档皆从此类注释取得 Java平台API文档是调用者(caller)和实现之间的契约(contract) 除非另有说明,Java平台API文档声明(assertion)应为与具体实现无关(implelementation-independent) Java平台API文档应有足够的声明,以使得软件质量保证部门能写出完全的JCK (Java Compatibility Kit)测试。 每个文档注释的第一句,应是个概要句,简明但无遗地描述API项。第一句在第一个后跟空格的点号前结束。当句中出现非结束意义的点加空格时,需要空格进行转义,如等。 自动重利用父类/接口方法,再加描述 @return @exception,多个异常时以异常名字的字母顺序为序 @see,多个参见时据 #field,#Constructor(Type, Type...),#Constructor(Type id, Typeid...),#method(Type, Type,...),#method(Type id, Type, id...),Class,Class#field,Class#Constructor(Type, Type...),Class#Constructor(Type id, Type id),Class#method(Type, Type,...),Class#method(Type id, Type id,...),package.Class,package.Class#field,package.Class#Constructor(Type, Type...),package.Class#Constructor(Type id, Type id),package.Class#method(Type, Type,...),package.Class#method(Type id, Type, id),package排序 @since @serial @deprcated @param和@return(当返回不是void时)都是必须的.
回复 使用道具 举报

Java中的注释表示有:
//    表示单行注释
                          
/*

*/    表示多行注释


/**


*/    表示文档说明书。

注释也可用于调试java程序。
回复 使用道具 举报
1. 将java文件(名字JavadocDemo.java)放置在某一目录,如:"D:/doc";

2. 运行cmd,进入该目录,执行“javadoc JavadocDemo.java”即可生成HTML格式的说明文档。

3. JavaDoc工具的使用格式如下:

javadoc [选项][软件包名称][源文件][@file]

    上述格式中的@file指的是包含文件,为了简化JavaDoc命令,可以将需要生成文档的软件包名和源文件名放到一个文本文件中。例如,为了简化以下命令:

javadoc  -d  mydoc  test.Student  test.Teacher

    可以建立一个名称为myfile.txt的文件,内容如下:

mydoc text.Student

text.Teacher

    然后执行命令

javadoc -d mydoc @myfile.txt

评分

参与人数 1技术分 +1 收起 理由
贠(yun)靖 + 1

查看全部评分

回复 使用道具 举报
您需要登录后才可以回帖 登录 | 加入黑马