Comentarios en el codigo [era: Ostia, el programa :) XD]

[Hernan Martinez Foffani]

Attila:
> kmilo <kmilo en softhome.net> escribió:
> > en vez de comentar lo que hace el modulo, ponle entre
> > triples comilla y asi queda como la cadena de documentacion
> > del modulo .....
>
> He estado buscando en la Guia del propio Van Rossum, porque me
> extraniaba, lo que dices sobre como
> comentar los modulos y no he encontrado nada que ponga que seria
> esa la forma adecuada. Es un
> estandar actual usarlo asi? ademas lo de 3 comillas me parecia
> mas raro aun. Me gustaria tener
> claro esto para documentar asi o no mis programas y modulos.

la convención sobre el estilo está en el PEP(*) 8, secciones
"Comments" y "Documentation Strings", donde se aconseja donde
usar comentarios con # y donde docstrings.
http://www.python.org/peps/pep-0008.html

y la convencion especifica de las docstrings está en el PEP 257.
incluye explicaciones sobre el uso de las triple comillas.
http://www.python.org/peps/pep-0257.html


(*) PEP == Python Enhancement Proposal)

-Hernan