create documentation with the comments present in the source code

Dietmar Lang dietmar at nospam.wohnheim.fh-wedel.de
Fri Sep 14 04:25:22 EDT 2001


Hi!

> As it is possible to put comment in 'python' code just after a function, a
> class as following :
> 
> def Function():
>     """
>     My comment
>     """
>     if ...
> 
> As it is possible to get this comment in the python command with an simple
> instruction...

Yes, here's a little interactive session:

>>> def Voila():
	"""This is documentation for Voila()"""
	pass

>>> print Voila.__doc__
This is documentation for Voila()
>>> 

There you go... If more details are needed, maybe someone here will jump
in... 

> Is there an utility which realize a pretty documentation with these comments
> ?

There propably is, else why don't you make one? ;)

Kudos, Dietmar

-- 
To mail me, remove 'nospam.'.



More information about the Python-list mailing list