pyisis 0.1

Horacio Degiorgi horaciod en gmail.com
Mar Feb 1 14:38:22 CET 2005


muchas gracias
lo intentaré
Horaciod



On Tue, 1 Feb 2005 08:42:05 +0100, David Asorey Álvarez
<forodejazz en gmail.com> wrote:
> > Me falta mucha documentacion y me pregunto como es la mejor manera de
> > hacerlo  ?
> > con comentarios en la forma """" comentario """" en cada def de la
> > clase o hay otra forma mejor ?
> > Estos comentarios se pueden extraer en forma de documentacion ? tipo javadoc ?
> >
> 
> Se suele poner un comentario detrás de la "declaración" de la clase
> explicando a grandes rasgos qué hace o para qué sirve la clase, y
> después de la declaración de cada método, un comentario un poco más
> preciso, concretando los parámetros que acepta y los resultados que
> devuelve.
> 
> Para extraer la documentación, la herramienta estándar de python es
> pydoc, tiene una opción (-w) para volcar a un fichero la
> documentación.
> 
> También está epydoc, un sistema "mejorado" que genera documentación
> muy parecida a la generada por javadoc.
> 
> Un documento interesante es la "Python Style Guide":
> 
> http://www.python.org/doc/essays/styleguide.html
> 
> Saludos.
> 
> --
> David Asorey Álvarez
> forodejazz en gmail.com
> _______________________________________________
> Python-es mailing list
> Python-es en aditel.org
> http://listas.aditel.org/listinfo/python-es
> 


-- 
Horacio Degiorgi
http://blog.codigophp.com




Más información sobre la lista de distribución Python-es