Write comments in Django

Question

These days I started working with Django, it's great!

I wonder if there is a "standard" to write comments in Django, for example, like codeigniter: http://codeigniter.com/user_guide/general/styleguide.html#commenting...

Thanks!

Answer 1

For Django views or any python file you can use the python style commenting

Like for single line comment your can try with

#

and for multiple line comment you can use """ """

and in templates you can do the html style commenting

like <!-- -->

Answer 2

I think it is a good idea to follow the PEP 8 recommendations for commenting your code. Also see PEP 257 for additional information about docstrings.