Next: , Previous: , Up: Coding style   [Contents][Index]


2.6 Comments

All comments shall be C-style comments, of the form ‘/* … */’. A comment can be placed immediately preceding the entity it describes or it can be placed together with code, variable declarations, or other non-comment entities. However, it is recommended to not mix various forms especially in types/structs descriptions.

Acceptable:

/* The page # that is the front buffer. */
int displayed_page;
int render_page; /* The page # that is the back buffer. */