How does eclipse generate Java Doc with custom tag

Source: Internet
Author: User

1. Select the project for which you want to generate a Java Doc, right-click the project, and choose export from the shortcut menu. The following dialog box is displayed;

2. Select Java> Javadoc and click Next. The following dialog box is displayed;

Click Configure ...] Click to generate Java doc javadoc.exe]

In the select types for which javadoc will be generated list, selectProgramPackage;

In the create javadoc for members with visibility area, select the Java Doc generation level:

[Private]: Generate Java Doc for all class members;

[Package]: generates Java Doc for all classes and members except private classes and private members;

[Protected]: generate a Java Doc for the protection class and common classes and their corresponding members;

[Public]: Generate Java Doc for common classes and members.

In this article, select public ].

Use a standard doclet to generate a Java Doc in HTML Format

Select the output directory of Java Doc. The default project directory is displayed in the [Doc] folder.

3. Click the next button. The following dialog box is displayed. Use the default settings:

4. Click 【next.pdf to set relevant parameters for javadoc.exe:

Enter the character set used by Java Doc in the VM options text box: This document uses the UTF-8 character set;

Define the custom tag to be output, which is determined by the custom tag. The format is described as follows.

For example, to customize the annotation Tag: @ descripton, you can define the parameter as follows:

-Tag Description: A: "description": keywords that can be recognized by javadoc.exe in the case of tag; description is a custom tag name; A indicates that all comments are displayed; "Description" indicates the text used to generate the Java Doc document.

Note: The order defined here determines the order in Java Doc.

Related Article

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.