doc tags?
Wolfram Kriesing
wolfram.kriesing at gmail.com
Fri May 13 17:11:36 EDT 2005
i am really looking for documenting my code, actually i expect the ide
to interpret them too and show me the doc etc., since i am missing
that a lot. esp. attributes' doc i was missing which made me write
this post
if there is not standard tool (or even a PEP) is there any pythonic
syntax? (which might make it into the standard lib, to be available
like the doc-string also inside the code - i really like the __doc__)
--
cu
Wolfram
On 5/13/05, Fredrik Lundh <fredrik at pythonware.com> wrote:
> 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>
>
>
> --
> http://mail.python.org/mailman/listinfo/python-list
>
More information about the Python-list
mailing list