what is "@param" in docstrings?
g.brandl-nospam at gmx.net
Sat Oct 28 20:36:10 CEST 2006
georgeryoung at gmail.com wrote:
> I'm starting to read about twisted and I keep seeing things like:
> [from twisted/internet/app.py]
> def __init__(self, name, uid=None, gid=None, authorizer=None,
> """Initialize me.
> If uid and gid arguments are not provided, this application
> default to having the uid and gid of the user and group who
> created it.
> @param name: a name
> @param uid: (optional) a POSIX user-id. Only used on POSIX
> @param gid: (optional) a POSIX group-id. Only used on POSIX
> self.name = name
> What does the "@param" mean? It looks like something meant to be
> machine readable. Alas, googling on "@param" doesn't work... It looks
> at first like a decorator, but that doesn't make much sense.
It's docstring markup that can be parsed by e.g. epydoc. It's borrowed
from JavaDoc's similar syntax.
More information about the Python-list