Generates corresponding help documents based on the source code of the open-source project.

Generates corresponding help documents based on the source code of the open-source project.

There are more and more open-source projects on the market, but although the projects are open-source, many related documents require us to pay for them. If you do not purchase the product, will we be unable to obtain the corresponding help documentation (PS: here we use struts2.2.1.1 as an example )?

The following describes how to use source code to generate a help document:

※1. Use MyEclipse to create a new project and place the source code of struts into it. At this time, errors are reported for the packages starting with org. In the src folder, but don't worry. Please proceed to the following:

※2. Introduce all jar packages in the struts2.2.1.1. jar file (except struts2.core) to the created Project:

※3. After completing step 1, most of the errors will be solved, but there are two legacy problems: httpRequest and httpResponse lack of references, so step 2 is to solve this problem:

Using the same reference method as step 1, introduce the jsp-appi.jar and servlet-api.jar jar packages in Tomcat into the project, save, and the entire project no longer prompts an error message. Everything is ready. We can start generating the work:

※4. After all the errors are solved, we start the generation phase:

After "Generate Javadoc" is selected, make the following options in the pop-up dialog box:

After all the operations are completed, click "Finish" to view the information on the Console tab:

After completing the information in the console.exe, copy the downloaded jd2chm.exe application to the folder where the generated document is located and run the cmd window command:

During the command execution, the computer will not respond in about one minute, so you must be patient at this stage. After the command window is executed, a prompt will be displayed, and such a file will appear in the pages of our folder, that is, the help document we need:

In this way, we are done. As long as there is open source project code, we can generate corresponding help documents, so Mom no longer has to worry about my learning!

Copyright Disclaimer: This article is an original article by the blogger and cannot be reproduced without the permission of the blogger.