技术开发 频道

Java开发必备小助手:Javadoc文档注释

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

  简单的说,Java中有三种注释方法:

  1. //被注释语句

  2. /*被注释语句*/

  3. /**被注释语句*/

  其中第三种专为JavaDoc设计,可以被JDK内置的JavaDoc工具支持和处理。

  如何使用Eclipse生成Javadoc

  1. 首先,选中Java目标工程,点击下拉菜单File,选中Export,会弹出Export对话框。

为了代码的可读性,今天你Javadoc了吗?

 

  2. 选中“Javadoc”,点击Next。

为了代码的可读性,今天你Javadoc了吗?

  3. Javadoc command输入框指定javadoc.exe所在路径。这里,Javadoc的对象既可以是整个工程,也可以是部分package或class。根据需要,选择适合的类型。Destination:这个路径是我们存放生成后的文档的路径。点击Finish。

为了代码的可读性,今天你Javadoc了吗?

0
相关文章