浅谈Javadoc

一、简介:

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

二、常用标记:

浅谈Javadoc此外还有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}几个不常用的标签,由于不常使用,不展开叙述。

三、生成Javadoc文件:

按照以下步骤:
“Project”->“Generate Javadoc”->“Configure”->找到Java安装文件中的JDK包下的javadoc.exe文件->“Finish”
然后就可以在项目中找到doc文件,生成的javadoc文件就在这里。

浅谈Javadoc