时间:2016-04-03 00:06 来源: 我爱IT技术网 编辑:52微风
我们项目写完后想要便于小伙伴分享,看源码又太麻烦,那么我们如何将项目生成API文档呢?这里利用javadoc可以生成。
前期准备工作(包括相关工具或所使用的原料等)myeclipse,eclipse 详细的操作方法或具体步骤
源码注释规范,一定要用/** 两个*这一特殊的注释。注释上可以添加@author等特殊说明,下图是部分 javadoc 标记 信息,可以根据需要选用。

确保整个工程的项目都添加了特殊注释后,右键工程,选择export导出。

选择java—>javadoc,然后点击next(下一步)。

这个选项可以选择javadoc命令,要生成api的工程以及API存放的路径。javadoc command会自动选择安装的jdk的bin目录下的javadoc应用程序,如果没有自动选择,点击configure选择。

选择完后点击next(下一步),可选择jar包,编辑标题,样式等,这里选择默认。

点击next(下一步),根据需要填写VM options信息。

最后点击”finish",选择”yes to all“开始生成java API文档信息。

生成后到刚刚保存的目录下,找到index.html打开文档查看信息。

- 评论列表(网友评论仅供网友表达个人看法,并不表明本站同意其观点或证实其描述)
-
