Generation of Java Help documentation

2. You first need to annotate the code with documentation, such as the following:
4. Package ? wz.learning;??
6. ???
8. /**?
10. ?*? Title:person<br>?
12. ?*? Description:?
14. ?*? COMPANY:SKJP?
16. ? *[email Protected]?xiashengwang?
18. ? *[email protected]?1.0?
20. ?*/??
22. Public ? class? Personwz? {??
24. ???? /**?
26. ????? *? This is the constructor for person ?
28. ????? *[email protected]?name? person 's name -?
30. ????? */??
32. ???? Public ? PERSONWZ (string?name) {??
34. ???????????
36. ????}??
38. ???????
40. ???? /**?
42. ????? *? This is the Read method ?
44. ????? *[email protected]?bookname? title ?
46. ????? *[email protected]?time? the time of reading ?
48. ????? *[email protected]? return Number of readings ?
50. ????? */??
52. ???? Public ? int ? Read (String?bookname,? int ? time) {??
54. ???????? return? 0;??
56. ????}??
58. }??

    2, through Eclipse generation is the simplest, in the project in the project list, right-click, select Export (Export), and then in the Export dialog box, select Javadoc under Java, submit to the next step.

    There are two places to note in the Javadoc Generation dialog box:
    Javadoc command: The bin/javadoc.exe of the JDK should be selected
    Destination: To create a saved path for a document, you can choose freely.
    Press Finish to submit to start generating the document.

    Note that the resulting document may be garbled and can be resolved as follows:

    Export the JavaDoc in Eclipse and fill in the parameters in extra JavaDoc Options on the last page of the wizard
    For example, the project uses the UTF-8 code to fill:-encoding UTF-8-charset UTF-8

    The document structure after the build is as follows:

    Click on the index, you can see our comments.

Generation of Java Help documentation