如何将java程序中的文档注释提取出来生成说明文档
2010-03-23 23:15
447 查看
javadoc技术,是从源代码中抽取类,方法,成员等文档注释形成一个与源代码配套的API帮助文档,用一套特定的标签做注释,在编程结束后,通过javadoc.exe生成开发文档。
常用的3种注释语句:
//用于单行注释
/*......*/用于多行注释,不能嵌套
/**.......*/用于支持javadoc的特有的文档注释语句
javadoc能从java源文件中读取第三种方式的注释并识别一些特殊的变量
@auth 作者信息
@version 版本信息
@parameter 参数名和意义
@since 参数名和意义
@return 返回值
@throws 异常类和抛出条件
@deprecated 引起不推荐使用的警告
@see 交叉参数
执行过程
同编译java文件一样
用javadoc TestJavaDoc.java
即可生成html的说明文档。
Javadoc的格式如下:
javadoc 选项|软件包名|源文件|@file
@file指包含文件,为了简化操作,可以把需要的软件包名和源文件放在一个文件中
javadoc ―d mydoc test.1 test.2
可以用一个名称为myfile.txt的文件内容:
mydoc test.1
test.2
然后执行:javadoc ―d mydoc @myfile.txt
javadoc工具的详细说明可以用javadoc -help命令本文出自 “三人行必有我师” 博客,请务必保留此出处http://00liuxiaolong.blog.51cto.com/967387/287303
常用的3种注释语句:
//用于单行注释
/*......*/用于多行注释,不能嵌套
/**.......*/用于支持javadoc的特有的文档注释语句
javadoc能从java源文件中读取第三种方式的注释并识别一些特殊的变量
@auth 作者信息
@version 版本信息
@parameter 参数名和意义
@since 参数名和意义
@return 返回值
@throws 异常类和抛出条件
@deprecated 引起不推荐使用的警告
@see 交叉参数
执行过程
同编译java文件一样
用javadoc TestJavaDoc.java
即可生成html的说明文档。
Javadoc的格式如下:
javadoc 选项|软件包名|源文件|@file
@file指包含文件,为了简化操作,可以把需要的软件包名和源文件放在一个文件中
javadoc ―d mydoc test.1 test.2
可以用一个名称为myfile.txt的文件内容:
mydoc test.1
test.2
然后执行:javadoc ―d mydoc @myfile.txt
javadoc工具的详细说明可以用javadoc -help命令本文出自 “三人行必有我师” 博客,请务必保留此出处http://00liuxiaolong.blog.51cto.com/967387/287303
相关文章推荐
- 第1章 Java基本概念及环境配置——FAQ1.16 如何将程序中的文档注释提取出来生成说明文档?
- Java注释写好了,如何提取出来生产说明文档呢?
- 磨刀不误砍材工 - Java的基础语言要素(注释-生成你自己的API说明文档)
- 如何为我们的程序编写开发文档——Java文档注释
- JAVA 文档注释,类的说明,HTML说明文档的生成
- Eclipse中如何修改Java代码注释的样式和如何提取出注释文档
- JAVA 文档注释,类的说明,HTML说明文档的生成
- 用myeclipse如何将java程序生成一个.exe可运行文件?
- Java程序如何生成Jar 执行文件(1)
- Java程序如何生成mdb文件[MS Access]?
- 如何能使xcode拥有自动注释并生成文档的功能
- Java程序如何生成Jar、exe及安装文件
- Java程序生成exe可执行文件详细教程(图文说明)
- Java程序生成exe可执行文件详细教程(图文说明)
- .net 下如何将文档文件(Word, Pdf等) 中的文本提取出来
- JAVA程序中,如何区别扫描仪扫出来的序号和用户如果手输入的序号?
- Java(四)——Java的文档注释(使用javadoc工具生成API文档)
- 如何使用Java程序打开一个Word文档?
- java注释生成文档 乱码,java.lang.IllegalArgumentException
- eclipse生成Java注释文档