Myeclipse文档注释如何提炼(导出)成自己的API帮助文档?

第一步:

        源码注释规范,一定要用/** 两个*这一特殊的注释。注释上可以添加@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打开文档查看信息。

          

          

posted @ 2017-09-14 14:59  白色的回忆  阅读(239)  评论(0编辑  收藏  举报