Skip to content

Instantly share code, notes, and snippets.

@tomblanchard
Last active August 29, 2015 13:55
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save tomblanchard/8699036 to your computer and use it in GitHub Desktop.
Save tomblanchard/8699036 to your computer and use it in GitHub Desktop.
Code comments.
/***********************************************************************************
  SECTION TITLE
 **********************************************************************************/

.element {
  background:red;
}
/***********************************************************************************
  SECTION TITLE
 ***********************************************************************************

  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ut ultrici
  diam. Cras ac neque facilisis, sodales augue in, ullamcorper ipsum. Donec nec da
  ibus dui. Curabitur interdum arcu ut mauris viverra adipiscing.

  <div class="foo">
    <p>Lorem</p>
  </div>

  Sodales augue in, ullamcorper ipsum. Donec nec dap ibus dui. Curabitur interdumr
  cu ut mauris viverra adipiscing.

 **********************************************************************************/

.element {
  background:green;
}
/**
  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ut ultrici
  diam. Cras ac neque facilisis, sodales augue in, ullamcorper ipsum. Donec nec da
  ibus dui. Curabitur interdum arcu ut mauris viverra adipiscing.

  <div class="foo">
    <p>Lorem</p>
  </div>

  Sodales augue in, ullamcorper ipsum. Donec nec dap ibus dui. Curabitur interdumr
  cu ut mauris viverra adipiscing.
 */
.element {
  background:blue;
}
<!--————————————————————————————————————————————————————————————————————————————————
  SECTION TITLE
  ———————————————————————————————————————————————————————————————————————————————-->
 
<div class="element"></div>
<!--————————————————————————————————————————————————————————————————————————————————
  SECTION TITLE
  ——————————————————————————————————————————————————————————————————————————————————

  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ut ultrici
  diam. Cras ac neque facilisis, sodales augue in, ullamcorper ipsum. Donec nec da
  ibus dui. Curabitur interdum arcu ut mauris viverra adipiscing.

  <div class="foo">
    <p>Lorem</p>
  </div>

  Sodales augue in, ullamcorper ipsum. Donec nec dap ibus dui. Curabitur interdumr
  cu ut mauris viverra adipiscing.

  ———————————————————————————————————————————————————————————————————————————————-->
 
<div class="element"></div>
<!--
  Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ut ultrici
  diam. Cras ac neque facilisis, sodales augue in, ullamcorper ipsum. Donec nec da
  ibus dui. Curabitur interdum arcu ut mauris viverra adipiscing.

  <div class="foo">
    <p>Lorem</p>
  </div>

  Sodales augue in, ullamcorper ipsum. Donec nec dap ibus dui. Curabitur interdumr
  cu ut mauris viverra adipiscing.
  -->
<div class="element"></div>

This is how I handle my code comments, there are 2 types:

  • Section header (with optional additional comment(s))
  • Regular comment(s)

All comments are limited to 80 characters per line with padding on each horizontal side consisting of two spaces.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment