Generate JavaDoc and intellijjavadoc for the self-designed class library in IntelliJ IDEA.

Generate JavaDoc and intellijjavadoc for the self-designed class library in IntelliJ IDEA.

A project needs to develop an XML analysis processor for other siblings in the team and design it as a class library to provide corresponding API interfaces. To facilitate your use, you need to generate the corresponding JavaDoc help document, just like the JavaDoc provided by the JavaSE standard library. My development tool is IntelliJ IDEA 12.1.6, which provides a good JavaDoc generation function and the standard JavaDoc annotation conversion function. Its essence is in the Code compiling process, write comments for the classes, methods, and other Members that need to be exposed to the user according to the standard JavaDoc annotation requirements. Then, the IDEA function is used to automatically call javadoc.exe (JDK's built-in tool) to automatically generate JavaDoc documents (Hyper Text Format) based on the comments in the source code ). You can easily find the standard JavaDoc annotation rules on the Internet. Pay special attention to the following points:

 

After JavaDoc is generated, you can find the index.html file in its root directory. Open it and you will see our own standard JavaDoc API documentation.