doc tags?

Fredrik Lundh fredrik at pythonware.com
Fri May 13 09:39:39 EDT 2005


Wolfram Kriesing wrote:

> i was already searching and remember i had seen something like "its not needed".
>
> Anyway, are there any doc tags, like in Java/PHPDoc etc, where you can
> describe parameters (@param[eter]), return values (@ret[urn]),
> attributes (@var), references (@see), etc?

do you want to use javadoc-style comments for your documentation?

    http://effbot.org/zone/pythondoc.htm

or are you just looking for some syntactic construct that uses an at-
sign?

    http://www.python.org/peps/pep-0318.html
    http://docs.python.org/ref/function.html

</F>






More information about the Python-list mailing list