How to document Python code properly for Pydoc

jorma kala jjkk73 at gmail.com
Wed Jul 22 15:39:09 CEST 2009


Hi,
Do you know where I can find the rules for documenting Python code, so that
automatic document generation with Pydoc makes the most of the comments
inserted in the code?
I know about documenting class and method through triple quote just under
the class definition. But how do you comment a specific field or variable,
or how do you document function arguments so that they are extracted like in
javadoc?
Thanks very much
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-list/attachments/20090722/827104d7/attachment.html>


More information about the Python-list mailing list