javadoc制作

javacdoc文档的制作

        当一个java或java web项目功能代码完成之后，通常我们会将这个项目发布。于是，如何让别人很轻松容易地了解或使用我们开发的项目就显得十分重要了。javadoc正是起着这样的作用，人们通过阅读项目的javadoc文档了解项目中各个类或接口的功能，从而更方便地使用我们的项目。

        下面讲解一下如何高效便捷地之所java项目doc文档。

        Step1：写注释，如何写javadoc注释，读者可以到搜索引擎上查一查，下面给出两个示例

        类的注释

        方法的注释

        Step2：当符合javadoc注释规范地完成了代码注释工作后，我们可以通过eclipse IDE来创建该项目的javadoc文档，步骤是：

       右击项目-->Export-->Export-->Java-->Javadoc-->Next-->并选择目标项目，选择javadoc生成的目标文件夹-->选中Use  standard doclet-->Next-->Next-->在Extra Javadoc options 处填写编码方案（如下图）-->Finish。

        除了这种方式外，还可以通过eclipse的菜单栏 

    I）Project——>Generate Javadoc——>后续同上，以导出javadoc

     II）工程上右键 —> Export —> java —> javadoc —>后续类似。

        如果代码的doc注释全部符合规范，则目标文件夹生成项目doc文件，如果doc注释有误，则报错，根据提示进行相应的修改再次尝试即可。

        UTF-8编码方式示例

        Step3：项目javadoc文档完成，就可以将我们的项目发布供别人使用了，通过javadoc文档，更让自己的项目完整清晰，受欢迎！

        今天就写到这里，敬请期待更新，欢迎各种形式的转载（务必注明出处），望每天进步一点