如何将java程序中的文档注释提取出来生成说明文档
原创
©著作权归作者所有:来自51CTO博客作者刘小龙的原创作品,请联系作者获取转载授权,否则将追究法律责任
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命令
上一篇:数据库的移植-不同数据库的移植
下一篇:weblogic9启动问题
提问和评论都可以,用心的回复会被更多人看到
评论
发布评论
相关文章
-
C# 代码注释生成代码提示和帮助文档
C# 代码注释生成代码提示和帮助文档
c# 帮助文档 xml 代码提示 html -
注释是对代码的“提示”,而不是文档
注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主, 注释太多了会让人眼花缭乱。注释的花样要少。
c++ #include ios 数据 c