How to Comment

[Jason]

Python has three ways to comment. The first way is only for a single line. You use the (#) for that. The 2nd and third ways allow for comments on more than one line without having to make a combo of one or more hashtags.

Let's say I want comment on a single line.

# This place is Admin Junkies.

Next, let's try the 2nd way.

""" This is a Admin Junkies.
It has a coding section.
Why not try it out?
Are you up to it? """

Finally, here is the last way:

# This is Admin Junkies. \
It has more than one theme \
Which ones do you like? \
Why is that the case?

O.K. what comment form do you like and why?

 

[Arantor]

I like a lot of short oneliners in the middle of functions/methods to annotate why something is so, and I like a good multiline comment with triple quotes for the function description.

Single line with escapes, ew.

Then again I'm so much happier with C conventions - // for single line, /* ..... */ for multi line.