Use of javadoc

Source: Internet
Author: User

Javadoc-D Doc XXXX. Java

After running this operation, an index.html file is displayed in the folder of a doc and you can see the comment in it.

Myeclipse has corresponding functions...
For example, a method is annotated as follows:
/**
* Search for this method ### (the function of this method is described here)
* @ Param ID # Table ID (here we will explain the parameters)
* @ Param key (same as above)
* @ Return string (return value)
* @ Throws: What are the exceptions thrown by throws in this method?
*/
Public String select (int id, string key)
{

}

Then, this function method of myeclipse is used as follows:
Click an export under file, select javadoc in Java, click Next, and select the method you want to generate in the tree structure. Directly finish the file and an additional Doc folder will appear in your project, open the index.htm file to view the details of the method you selected .. the format is the same as that of the CHM help file...
That's all you know. I hope it will help you ..

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.