/* JavaDoc above */
def inconsistentComments(){
""" Python docstrings below """

  • 0
  • 4
    when it's longer than one line, explaining more than the following line, or explaining what the following line does, then above.

    when it's a bit of additional info for the line of code, then next to it:

    position += orientation * speed * deltaTime; //deltaTime to make it go brrr framerate-independently
  • 1
    Comments are always above or inline. Documentation blocks vary in languages but are generally above the definition.
    Perl POD is often below all the code.
  • 1
    Actually would be interested what you comment?
Add Comment