10
Sé cuál es la forma estándar de documentar funciones, clases y módulos, pero ¿cómo doblo los paquetes? ¿Pongo una docstring en __init__.py, o alguna otra cosa?cómo documentar un paquete python
A
Respuesta
14
Sí, al igual que para un comentario de función o de clase, el primer elemento en el archivo __init__.py debe ser una cadena de comentario:
"""
This is the xyz package.
"""
Ahora bien, si se importa el paquete, y utilizar la ayuda (paquete), verá su docstring. Ver más aquí: http://www.python.org/dev/peps/pep-0257/
3
Ver PEP257
Un paquete puede ser documentada en la cadena de documentación del módulo del archivo __.py __ init en el directorio del paquete.
-3
Documentar es una buena idea, siempre y cuando no documenta algo obvio en el código
tratar de entender que la mayoría de la gente que lee su fuente entenderá pitón, por lo que al comentar o documentar líneas de este tipo es inútil:
a = 1 #this assigns 1 to a
Pero comentar o documentar una función o clase bastante complicada es una buena idea.
Regla general: Imagina que la siguiente persona que trabaja en tu código es un maníaco que maneja Ax y saben dónde vives.
De esa manera siempre dejará comentarios "útiles"/doc's
Cuestiones relacionadas
- 1. ¿Cómo documentar un proyecto de Python?
- 2. Documentar paquetes de Python con doxygen
- 3. Cómo documentar campos y propiedades en Python?
- 4. Ejecutando un paquete python
- 5. Cómo documentar un archivo MAKE?
- 6. ¿Cómo documentar un tipo de pato?
- 7. ¿Cómo actualizo un paquete de Python?
- 8. Cómo documentar el código de Python con doxygen
- 9. ¿Cómo documentar los atributos de clase en Python?
- 10. ¿Cómo puedo documentar un C# dll
- 11. ¿Cómo puedo documentar paquetes en Java?
- 12. Cómo documentar el código de Python: Epydoc, doxygen, Sphinx, ...?
- 13. python/dpkt: Averigüe si el paquete es un paquete tcp o un paquete udp,
- 14. Cómo documentar getters y setters
- 15. Python: módulo 'Privado' en un paquete
- 16. No se puede instalar un paquete Python
- 17. Cómo subir un paquete de Python prístino a PyPI?
- 18. ¿Cómo instalar un paquete de Python desde dentro de IPython?
- 19. Cómo crear un paquete de Python 2.x - simple caso
- 20. Usando sphinx para auto-documentar una clase python, módulo
- 21. ¿Cómo hago el paquete de Debian de un paquete de Python?
- 22. Dependencias externas del paquete Python
- 23. ¿Cómo documentar correctamente los métodos S4 "[" y "[<-" usando roxygen?
- 24. ¿Cómo serializar un paquete?
- 25. PIP instala un paquete de Python sin un archivo setup.py?
- 26. Cómo documentar un objeto de función con doxygen?
- 27. ¿Cómo documentar un método que anula otro método?
- 28. ¿Cómo documentar un generador de funciones con jsdoc?
- 29. Cómo organizar, probar, documentar y empaquetar un proyecto de Clojure
- 30. Cómo documentar un parámetro que espera una constante