4. Notes

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.