Previous: Comments, Up: Coding style


2.7 Multi-Line Comments

Comments spanning multiple lines shall be formatted with all lines after the first aligned with the first line.

Asterisk characters should not be repeated a the start of each subsequent line.

Acceptable:

     /* This is a comment
        which spans multiple lines.
        It is long.  */

Unacceptable:

     /*
      * This is a comment
      * which spans multiple lines.
      * It is long. */

The opening ‘/*’ and closing ‘*/’ should be placed together on a line with text.