JavaDoc注释的使用

       Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。

 

       JavaDoc注释格式为 /**  被注释内容*/     ，之中关键字如下：

       @author 作者名

       @version 版本标识

       @parameter 参数及其意义

       @since 最早使用该方法/类/接口的JDK版本

       @return 返回值

       @throws 异常类及抛出条件

       @deprecated 引起不推荐使用的警告

       @see reference

       @override 重写

 

       使用eclipse生成文档（javadoc）主要有三种方法：

      1.在项目列表中按右键，选择Export（导出），然后在Export(导出)对话框中选择java下的javadoc，提交到下一步。 在Javadoc Generation对话框中有两个地方要注意的： javadoc command:应该选择jdk的bin/javadoc.exe .  destination:为生成文档的保存路径，可自由选择。 按finish(完成)提交即可开始生成文档。

      2.用菜单选择：File->Export(文件－>导出)， 剩下的步骤和第一种方法是一样的。

      3.选中要生成文档的项目，然后用菜单选择， Project->Generate Javadoc,直接进入Javadoc Generation对话框，剩余的步骤就和第一种方法在Javadoc Generation对话框开始是一样的。