What is javadoc?

Source: Internet
Author: User
Javadoc is a technology provided by Sun. It extracts class, method, and member comments from the program source code to form an API help document supporting the source code. That is to say, as long as the program is compiled with a specific set of labels for annotation, after the program is compiled, through javadoc can form the program development documentation at the same time.
JBuilder provides multiple functions that support javadoc. You can create a javadoc node in the tree of the Project pane by using the wizard, and create the javadoc document of the project by naming the node menu, the javadoc labels can be entered through induction to check whether the comments match the source code.
This article describes how to use the javadoc tag in the source code to write comments and create a javadoc document.
Although detailed design is an important stage of software projects, it is often not implemented in practice. It is not that this phase is not important, but it is very difficult to implement it, because the software demand is a natural mobile disease patient. After the detailed design, the demand is already quite different from the original version, with a huge cost, the elaborate detailed design has become yellow yesterday.
Javadoc comments are composed of javadoc labels and descriptive texts. You can add comments to classes and interfaces, or add comments to elements in constructors, Value domains, methods, and other classes.
You can use a code template to quickly enter javadoc comments, or you can use the javadoc dialog box to input javadoc comments in a visualized manner. In addition, JBuilder provides a variety of javadoc auxiliary functions, such as javadocinsight-induced input, conflict reporting and correction, and special todo labels.
After writing comments in the Java file, you can immediately switch to the corresponding javadoc document in the doc view page code in the content pane, however, the documents generated on the doc view page are incomplete "templates ". First, there is no navigation tree, and second, no links are generated to associate content through @ see or @ link. So you can regard the javadoc document on the doc view page as a preview of the final version of javadoc.
This article describes the javadoc labels and explains how to edit javadoc annotations in JBuilder. You should try to use javadocinsight, classinsight and parameterinsight to quickly and correctly compile javadoc annotations. In addition, you should make common annotations into templates to facilitate quick entry.
The annotation conflict report and recovery functions provided by JBuilder allow you to easily solve the annotation conflict problem and avoid monotonous manual adjustment operations.
JBuilder also allows you to customize javadoc labels to meet Personalized Requirements. In addition, the custom todo tag of JBuilder allows you to mark the desired location anytime and anywhere, so that you do not miss out on your work.

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.