How to comment code?

Pavel Panchekha PavPanchekha at gmail.com
Fri Jan 19 17:18:19 EST 2007


I think that doc strings are the most important way in which you should
be commenting on your code. Once the code works, you can elimainate
most inline comments, leaving only doc string for everything and a few
comments on some particularly confusing parts. Other than that,
comments usually only clutter Python code. But remember that you are
the person who understands your code best, so don't be too fanatical
about deleting inline comments.




More information about the Python-list mailing list