Skip to content

Latest commit

 

History

History
17 lines (11 loc) · 530 Bytes

comment-format.md

File metadata and controls

17 lines (11 loc) · 530 Bytes

Comments

These are my personal rules of thumb for writing comments in code.

Capitalization and punctuation

# Write comments in sentence case, where possible

echo 'hi' # This is a comment to the right of code

# This is a comment. There are periods here only because there are multiple
# sentences.

# someVar is a variable. Identifier case is not changed.