Eclipse用法:使用Javadoc导出项目的API文档

eclipse直接自动生成整个项目的API帮助文档的小tips

另外,eclipse加入doc注释的快捷键:Shift+Alt+J

本文将具体讲述使用Eclipse开发工具导出项目的Javadoc文档的步骤和常见的问题。

技术文档是项目的重要组成部分,Javadoc则是Java技术文档的基础之一。Javadoc为Java代码生成一组便于使用的API文档,作为沟通工具,这些文档可提供有益的帮助,使团队成员理解其他成员正在进行的工作。

当然,要获得良好的Javadoc文档,要求源代码中有精心编写的有意义的注释,对任何工具而言,这都是苛刻的要求。这不是本文的重点内容。

原文链接

但是原文中的最后一步:

  1. VM options中填入-encoding utf-8
    -charset utf-8
    ,具体的编码方式,根据你的项目 

的编码方式决定。点击Finish 

注意:如果编码方式不对,会出现编码错误报错!!! 


我添加了charset反而会报错,这一步空着反而没有问题。。

你可能感兴趣的:(eclipse,api,javadoc,帮助文档)