search

KOBUGE-Games / minilens

Cute puzzle platformer starring a cleaning robot on post-apocalyptic Earth
http://kobuge-games.github.io/minilens
GNU General Public License v3.0
134 stars 38 forks source link

Comment style consistency #51

Closed Calinou closed 8 years ago

Calinou commented 9 years ago

When browsing Minilens' code, I sometimes see these variants of comments:

#example comment
#Example comment
# example comment
# Example comment

We should settle on one style. I personally suggest # Example comment for comments, and #commented_out_code for code that was commented out (note the lack of space between the # and the code).

Typos are also quite frequent.

bojidar-bg commented 9 years ago

@Calinou sorry, I wrote all comments in a hurry, so typos and variations are common...

akien-mga commented 8 years ago

I think the Python convention is a good one to follow: https://www.python.org/dev/peps/pep-0008/#comments