estilo de los comentarios

[Chema Cortes]

El 7/11/06, camontuyu<camontuyu en yahoo.es> escribió:
> Hola, estoy buscando programas para generar la documentación de mis
> funciones y mis clases a partir de los docstring.
>
> He estado leyendo los diferentes programas que indican en
> http://www.python.org/dev/peps/pep-0256/ y la verdad no se cual elegir.
>
> ¿Me recomendáis alguno en especial? pydoc viene dentro ya de python así
> que no se que hacer.

Se usa mucho el doxygen, sobre todo en proyectos grandes donde se
combinen varios lenguajes de programación. Pero ya que pides una
recomendación, usa pydoc con el parser reStructuredText (incluído en
docutils <http://docutils.sourceforge.net>). Entre otras cosas, se
puede combinar con doctest para realizar pruebas automáticas, o
generar gráficos tales como fórmulas matemáticas expresadas en LaTeX.
El propio Guido dijo que debería ser parte de la librería estándar y
no le falta razón.

Pero, claro, esto depende un poco de tus necesidades. Si te interesa
algo estos temas, por esta lista andamos unos cuantos interesados en
"Programación Literaria": http://www.literateprogramming.com