An example of integration and use of Doxygen automated document generation tools in eclipse

Do you have trouble writing documentation for your software? What will you do when someone gives you a huge system that allows you to write a complete development document based on the code annotation inside? Look at the code and then take n days to write it? This is both a chore and extremely time-consuming, is there a better way? For example, automatically generate detailed documentation based on code comments ... Some people may say that the use of Javadoc is, if C + +, Python, C # and other languages written software? Is there anything like Javadoc?

Yes, of course, Doxygen is such a tool to meet your needs. Doxygen is an open source Cross-platform, document system similar to the Javadoc style description, fully supports C, C + +, Java, objective-c, and IDL languages, and partially supports PHP and C #. The syntax of the annotation is compatible with Qt-doc, KDOC, and Javadoc. Doxgen can start with a set of archive source files, convert specific annotations in a program into a description file, generate an online class browser in HTML format, or an offline latex, RTF reference manual. Many projects, such as boost, Opencascade, are the only choice for document generation tools.

Since my main development language is Java, I'm here to illustrate Doxygen's integration and usage steps in Eclipse.

1. Install Doxygen Tools

You need to install the Doxygen tool before integration, there are two ways to download it: The latest version is 1.8.6

(1) Official website Download (recommended):doxygen:downloads

(2) Download in SourceForge: Doxygen

2. Install Doxygen plugins in eclipse: Eclox

Recommended to download on its official website: Eclox