Skip to content

Comment Formats

Mike Mai edited this page Jul 31, 2018 · 2 revisions

CSS Section Grouping

Heading

Use block comments as section headings.

/**
 * Section Heading (+ description, etc if it makes sense)
 */

Spacing Break

Use line breaks to separate groups of related code. Reference this.

Everything Else

Use preprocessor comments for all other comments.

// This is a comment.

To Do

Write todo comments with your name, so you can be the point of reference when we need to create a task based on todo's.

// @todo: [Your Name] We need to take care of this later.
Clone this wiki locally