javadoc常用的标记以及生成API文档的方法

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/qq_33615172/article/details/51451239

@author: 作者

@version: 版本

@docroot: 表示产生文档的根路径

@deprecated: 不推荐使用的方法

@param: 方法的参数类型

@return: 方法的返回类型

@see: 用于指定参考的内容

@exception: 抛出的异常

@throws: 抛出的异常,和exception同义。


需要注意这些标记的使用是有位置限制的。其中可以出现在类或者接口文档注释中的标记有:@see、@deprecated、

@author、@version等。可以出现在方法或者构造器文档注释中的标记有:@see、@deprecated、@param、@return、@throws、

@exception等。可以出现在文档注释中的有:@see、@deprecated等。 


使用javadoc注释,生成API文档的方法:

点击整个工程,右键点击Export

选择Java下的Javadoc,点击Next

Configure选择jdk安装路径下的\bin\javadoc.exe,Browse选择生成的API文档的存放位置,点击Finish,点击Yes To All





博主设置当前文章不允许评论。

没有更多推荐了,返回首页