4. Notes

Source: Internet
Author: User
Block annotations are usually used to provide descriptions of files, methods, data structures, and algorithms. Block annotations are placed at the beginning of each file and before each method. They can also be used in other places, such as internal methods. Block comments inside functions and methods should have the same indent format as the code they describe. There should be a blank line at the beginning of the block comment for block comment and generation

Block annotations are usually used to provide descriptions of files, methods, data structures, and algorithms. Block annotations are placed at the beginning of each file and before each method. They can also be used in other places, such as internal methods. Block comments inside functions and methods should have the same indent format as the code they describe.

There should be a blank line at the beginning of the block comment to separate the block comment from the code, for example:


/*
* Here is the block comment.
*/

The block annotation can start with/*-, so that indent (1) can recognize it as the beginning of a code block without shuffling it.


/*-
* If you want to be ignored, block annotations in special format are used.
*
* One
* Two
* Three
*/

Note: If you do not use indent (1), you do not need to use/*-in the code, or make concessions for others to run indent (1) on your code.

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.