javaDoc

原创
2013/12/18 16:51
阅读数 61

我们知道Java中有三种注释语句:

1.//用于单行注释。
2./*...*/用于多行注释,从/*开始,到*/结束,不能嵌套。
3./**...*/则是为支持jdk工具javadoc.exe而特有的注释语句。
   javadoc工具能从java源文件中读取第三种注释,并能识别注释中用@标识的一些特殊变量(见表),制作成Html格式的类说明文档。 javadoc不但能对一个java源文件生成注释文档,而且能对目录和包生成交叉链接的html格式的类说明文档,十分方便。

注释中可以出现的关键字,以@开头:
@author        作者名
@version       版本标识
@parameter     参数名及其意义
@since         最早出现的JDK版本
@return        返回值
@throws        异常类及抛出条件
@deprecated    引起不推荐使用的警告
@see           交叉参考

这些我们可以在eclipse里面配置 在windows->preference->java->Code Style->Code Templates

编写一个JavadocDemo.java 目录为D:\playws 

在cmd 里面先找到这个java 文件 

//找到D盘

cmd->d:

//找到这个文件

cmd->cd palyws

//编译 Java文件

cmd->javac JavadocDemo.java

//运行Java文件

cmd->java JavadocDemo

//获得Javadoc 文件

cmd->javadoc JavadocDemo.java





展开阅读全文
加载中
点击引领话题📣 发布并加入讨论🔥
打赏
0 评论
0 收藏
0
分享
返回顶部
顶部