Shulou(Shulou.com)06/02 Report--

This article introduces the relevant knowledge of "what are the functions of the java API file generator". In the operation of actual cases, many people will encounter such a dilemma, so let the editor lead you to learn how to deal with these situations. I hope you can read it carefully and be able to achieve something!

Javadoc API file generator

The Javadoc program reads a Java class file and automatically creates a set of HTML files. These HTML files describe the classes, variables and member functions of the Java class file. All the APIHTML files of the Java class library can be created by this program. Javadoc treats the package name or list of source files as a variable. Javadoc relies on the @ comment tag to create the HTML file. Here is a list of annotations that Javadoc uses to create links in the HTML file.

Option function

@ see classname this annotation adds a "See Also" entry to the class list to the provided class.

@ see classname # methodname this annotation creates a "See Also" entry to a specific member function.

@ version text this annotation adds a version information entry to the HTML file

@ author text this annotation adds an author information entry to the HTML file

@ param name description this annotation uses member function comments to describe the variables carried by a member function

@ return description this annotation uses member function comments to describe the return value

@ exception classname this annotation uses member function comments to connect exception exits generated by member functions

-classpath path this command line specifies the directory where the Java file is found

-d directory this command line specifies that it is useful to put the final HTML file.

This is the end of the content of "what are the functions of the java API file generator". Thank you for reading. If you want to know more about the industry, you can follow the website, the editor will output more high-quality practical articles for you!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.