首页 > 代码库 > 如何导出API文档,没有你做不到,只有你想不到!

如何导出API文档,没有你做不到,只有你想不到!

1,源码注释规范,一定要用/** 两个*这一特殊的注释。注释上可以添加@author等特殊说明,下图是部分 javadoc 标记 信息,可以根据需要选用。1

             技术分享

     技术分享

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

          技术分享
3,选择java—>javadoc,然后点击next(下一步)。

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

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

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

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

          技术分享

PS------------>图片借鉴逍遥菠菜!

如何导出API文档,没有你做不到,只有你想不到!