如何使用eclipse生成javadoc帮助文档

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。下面将在eclipse中详细操作，如何生成javadoc帮助文档。

1. 1

   首先，打开Eclipse，在需要生成Javadoc的项目上右击鼠标，在弹出来的列表中点击”导出(O)...“选项。

   

2. 
   

3. 
   

4. 
   

5. 
   

6. 
   

7. 2

   在弹出来的”导出“窗口中，选择导出的目标，这里选择Java文件夹下的Javadoc，然后点击”下一步（N）“按钮。

   

8. 
   

9. 
   

10. 
    

11. 
    

12. 
    

13. 
    

14. 
    

15. 3

    进入到”选择生成Javadoc的类型“界面，这里默认已经配置好了生成Javdoc的javadoc.exe的路径，如果不对可以重新配置，在“使用标准Doclet(S)”一栏中选择输入Javadoc的目录，默认实在工作空间工程项目下的doc文件夹中，也可以自行配置，然后点击”下一步（N）“按钮。

    

16. 
    

17. 
    

18. 
    

19. 
    

20. 
    

21. 
    

22. 
    

23. 
    

24. 4

    进入到”配置标准doclet的Javadoc自变量“界面，可以根据需要配置Javadoc的自变量，可以通过”基本选项“下的复选框来选择Javadoc选项。如果想引用一个库中的类，并且将该库链接到它的javadoc，可以在“选择应将链接生成至的被引用归档和项目（R）”列表中选择，然后点击“下一步（N）”按钮。

    

25. 
    

26. 
    

27. 
    

28. 
    

29. 
    

30. 
    

31. 
    

32. 
    

33. 5

    进入到“配置Javadoc自变量”界面，这里注意：如果项目采用的是UTF-8编码，Extra Javadoc options（额外的Javadoc选项）下需要输入设定参数：-encoding utf-8 -charset utf-8否则生成的网页中文注释都是乱码，点击“完后”按钮。

    

34. 
    

35. 
    

36. 
    

37. 
    

38. 
    

39. 
    

40. 
    

41. 
    

42. 6

    在点击“完成”按钮后，会看到Eclipse主界面的“控制台”输入Javdoc生成成功的信息。

    

43. 
    

44. 
    

45. 
    

46. 
    

47. 
    

48. 7

    查看生成的Javadoc帮助文档。

    进入到工作空间对应的工程项目下，可以看到有个doc文件夹（当然这是默认的输出目录，如果你在生成Javadoc时设置了其它目录，可以进相应的目录中）。

    

49. 
    

50. 
    

51. 
    

52. 
    

53. 
    

54. 8

    点击进度doc文件夹，会发现doc文件夹中有好多.html文件，打开index.html文件。

    

55. 
    

56. 
    

57. 
    

58. 
    

59. 
    

60. 9

    可以看到生成的API文档，这里面显示了过程中的相应信息。

    

61. 
    

62. 
    

63. 
    

64. 
    

65. 10

    点击其中的类，可以看到相应类的信息，如你设置的版本、作者，还可以看到继承的类等信息，有助于快速了解源代码。

    
66. 
    
67. 
    
68. 
    
69. 
    
70. 文章来源：https://jingyan.baidu.com/article/dca1fa6f4d3d7ff1a4405239.html    侵删请联系。