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

待我称王封你为后i 2022-06-04 00:25 305阅读 0赞

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

1.  1
    
    首先，打开Eclipse，在需要生成Javadoc的项目上右击鼠标，在弹出来的列表中点击”导出(O)...“选项。
    
    [![如何使用eclipse生成javadoc帮助文档？][eclipse_javadoc]][eclipse_javadoc_eclipse_javadoc]
2.    
    
3.    
    
4.    
    
5.    
    
6.    
    
7.  2
    
    在弹出来的”导出“窗口中，选择导出的目标，这里选择Java文件夹下的Javadoc，然后点击”下一步（N）“按钮。
    
    [![如何使用eclipse生成javadoc帮助文档？][eclipse_javadoc 1]][eclipse_javadoc_eclipse_javadoc 1]
8.    
    
9.    
    
10.   
    
11.   
    
12.   
    
13.   
    
14.   
    
15. 3
    
    进入到”选择生成Javadoc的类型“界面，这里默认已经配置好了生成Javdoc的javadoc.exe的路径，如果不对可以重新配置，在“使用标准Doclet(S)”一栏中选择输入Javadoc的目录，默认实在工作空间工程项目下的doc文件夹中，也可以自行配置，然后点击”下一步（N）“按钮。
    
    [![如何使用eclipse生成javadoc帮助文档？][eclipse_javadoc 2]][eclipse_javadoc_eclipse_javadoc 2]
16.   
    
17.   
    
18.   
    
19.   
    
20.   
    
21.   
    
22.   
    
23.   
    
24. 4
    
    进入到”配置标准doclet的Javadoc自变量“界面，可以根据需要配置Javadoc的自变量，可以通过”基本选项“下的复选框来选择Javadoc选项。如果想引用一个库中的类，并且将该库链接到它的javadoc，可以在“选择应将链接生成至的被引用归档和项目（R）”列表中选择，然后点击“下一步（N）”按钮。
    
    [![如何使用eclipse生成javadoc帮助文档？][eclipse_javadoc 3]][eclipse_javadoc_eclipse_javadoc 3]
25.   
    
26.   
    
27.   
    
28.   
    
29.   
    
30.   
    
31.   
    
32.   
    
33. 5
    
    进入到“配置Javadoc自变量”界面，这里**注意**：如果项目采用的是UTF-8编码，Extra Javadoc options（额外的Javadoc选项）下需要输入设定参数：-encoding utf-8 -charset utf-8否则生成的网页中文注释都是乱码，点击“完后”按钮。
    
    [![如何使用eclipse生成javadoc帮助文档？][eclipse_javadoc 4]][eclipse_javadoc_eclipse_javadoc 4]
34.   
    
35.   
    
36.   
    
37.   
    
38.   
    
39.   
    
40.   
    
41.   
    
42. 6
    
    在点击“完成”按钮后，会看到Eclipse主界面的“控制台”输入Javdoc生成成功的信息。
    
    [![如何使用eclipse生成javadoc帮助文档？][eclipse_javadoc 5]][eclipse_javadoc_eclipse_javadoc 5]
43.   
    
44.   
    
45.   
    
46.   
    
47.   
    
48. 7
    
    查看生成的Javadoc帮助文档。
    
    进入到工作空间对应的工程项目下，可以看到有个doc文件夹（当然这是默认的输出目录，如果你在生成Javadoc时设置了其它目录，可以进相应的目录中）。
    
    [![如何使用eclipse生成javadoc帮助文档？][eclipse_javadoc 6]][eclipse_javadoc_eclipse_javadoc 6]
49.   
    
50.   
    
51.   
    
52.   
    
53.   
    
54. 8
    
    点击进度doc文件夹，会发现doc文件夹中有好多.html文件，打开index.html文件。
    
    [![如何使用eclipse生成javadoc帮助文档？][eclipse_javadoc 7]][eclipse_javadoc_eclipse_javadoc 7]
55.   
    
56.   
    
57.   
    
58.   
    
59.   
    
60. 9
    
    可以看到生成的API文档，这里面显示了过程中的相应信息。
    
    [![如何使用eclipse生成javadoc帮助文档？][eclipse_javadoc 8]][eclipse_javadoc_eclipse_javadoc 8]
61.   
    
62.   
    
63.   
    
64.   
    
65. 10
    
    点击其中的类，可以看到相应类的信息，如你设置的版本、作者，还可以看到继承的类等信息，有助于快速了解源代码。
    
    [![如何使用eclipse生成javadoc帮助文档？][eclipse_javadoc 9]][eclipse_javadoc_eclipse_javadoc 9]
66.   
    
67.   
    
68.   
    
69.   
    
70. 文章来源：https://jingyan.baidu.com/article/dca1fa6f4d3d7ff1a4405239.html 侵删请联系。

[eclipse_javadoc]: https://imgsa.baidu.com/exp/w=500/sign=84aac056b0fd5266a72b3c149b199799/1f178a82b9014a90f3628a00af773912b31bee2b.jpg
[eclipse_javadoc_eclipse_javadoc]: /images/20220604/40dc6008733f482aa70f46e9cc131571.png
[eclipse_javadoc 1]: https://imgsa.baidu.com/exp/w=500/sign=2ce82db28194a4c20a23e72b3ef51bac/79f0f736afc37931f0354a94edc4b74543a9112a.jpg
[eclipse_javadoc_eclipse_javadoc 1]: /images/20220604/0a7d6cf634514e88823f7ba193b0e940.png
[eclipse_javadoc 2]: https://imgsa.baidu.com/exp/w=500/sign=2d7bf7791dd5ad6eaaf964eab1ca39a3/b219ebc4b74543a97d46367118178a82b901142a.jpg
[eclipse_javadoc_eclipse_javadoc 2]: /images/20220604/3ea70cf6365d42f5ab40d8642ea1bbea.png
[eclipse_javadoc 3]: https://imgsa.baidu.com/exp/w=500/sign=fc98a7528bb1cb133e693c13ed5556da/bba1cd11728b471071223171c5cec3fdfc03237a.jpg
[eclipse_javadoc_eclipse_javadoc 3]: /images/20220604/d52dee4c7a9f41e7a03d591555497dfd.png
[eclipse_javadoc 4]: https://imgsa.baidu.com/exp/w=500/sign=c3f74ec845a98226b8c12b27ba83b97a/0bd162d9f2d3572c39ec50618c13632762d0c305.jpg
[eclipse_javadoc_eclipse_javadoc 4]: /images/20220604/bd0fe43f1b5d4a69b3653f54cd5cc253.png
[eclipse_javadoc 5]: https://imgsa.baidu.com/exp/w=500/sign=9937a322a20f4bfb8cd09e54334e788f/9f2f070828381f30f2114114af014c086e06f007.jpg
[eclipse_javadoc_eclipse_javadoc 5]: /images/20220604/4b8b72a526564278888b98742fbd4d35.png
[eclipse_javadoc 6]: https://imgsa.baidu.com/exp/w=500/sign=0f0de358ab6eddc426e7b4fb09dab6a2/eac4b74543a98226ce05e69a8c82b9014b90eb43.jpg
[eclipse_javadoc_eclipse_javadoc 6]: /images/20220604/61e72fc9c2db40e381672a8d53335217.png
[eclipse_javadoc 7]: https://imgsa.baidu.com/exp/w=500/sign=15fef3cbf41fbe091c5ec3145b610c30/902397dda144ad3437b74b3ad6a20cf431ad8507.jpg
[eclipse_javadoc_eclipse_javadoc 7]: /images/20220604/b3f54c7e858b4915a70e83043a16f1df.png
[eclipse_javadoc 8]: https://imgsa.baidu.com/exp/w=500/sign=62eca882dff9d72a1764101de42b282a/77094b36acaf2edddb6c85548b1001e9380193ea.jpg
[eclipse_javadoc_eclipse_javadoc 8]: /images/20220604/44cca83ca2d14e7388cd4034c6847fab.png
[eclipse_javadoc 9]: https://imgsa.baidu.com/exp/w=500/sign=0ceb4b96b651f819f125034aeab54a76/09fa513d269759ee0894ad76b4fb43166c22df43.jpg
[eclipse_javadoc_eclipse_javadoc 9]: /images/20220604/40dc6008733f482aa70f46e9cc131571.png0