19
¿Qué hay en las convenciones y herramientas para documentar el código fuente de python?documentación de código para python
A
Respuesta
9
Epydoc es también una buena herramienta para la documentación de código fuente, y se ocupa de las clases de referencias cruzadas, módulos, variables, etc, en HTML, PDF, LaTeX. Dibuja algunos buenos diagramas de herencia de clase también. Es utilizado por una serie de proyectos de código abierto, por lo que se desarrolla bastante activamente.
35
Convenciones: PEP 257 y PEP 8. Nota , que docstrings se pueden escribir en reStructuredText
Herramientas para la generación de documentación: por ejemplo Sphinx
6
Es muy agradable para poner la documentación del código en el código mismo. Ver:
16
Primero, ponga comentarios en sus documentos mediante el formato RestructuredText.
En segundo lugar, obtenga sphinx.
En tercer lugar, cree un índice que use el autodoc extension.
Luego, ejecute Sphinx para obtener una buena documentación.
1
usando doxypy filtro con doxygen es una buena cosa también
Cuestiones relacionadas
- 1. Sphinx para la documentación del código php
- 2. Documentación para gnomekeyring Python lib
- 3. Documentación del código Xcode
- 4. Buena documentación/tutorial para python webkit
- 5. documentación en modo python para Emacs
- 6. subversion python vinculantes documentación?
- 7. Documentación oculta de Python mysqldb
- 8. Extensión de Python C: firmas de métodos para la documentación?
- 9. Documentación automática del código de ColdFusion
- 10. Documentación del código de Visual Basic 6.0
- 11. ¿Dónde puedo encontrar la documentación de vtk para python?
- 12. Documentación del código VBA para Excel Auto Complete
- 13. Documentación de Python: ¿iterable muchas veces?
- 14. "rebanar" en la documentación de Python Expresiones
- 15. Documentación oficial para MVC3
- 16. Documentación básica para Rcpp
- 17. ¿Hay una documentación del depósito giratorio para Python?
- 18. código python para comparar imágenes en Python
- 19. Autogenerar documentación ficticia en el código fuente de Python en eclipse
- 20. ¿Cómo puedo quitar los comentarios y las cadenas de documentación del código fuente de Python?
- 21. Documentación para comentarios sobre la documentación de Qt? Qt + Doxygen?
- 22. Graphviz para la documentación
- 23. documentación para STL
- 24. Documentación para Socket.io?
- 25. Api documentación para Rspec?
- 26. PyQt documentación
- 27. ¿Alguna buena alternativa para Sphinx para proporcionar documentación de software?
- 28. Crear PDF a partir de la documentación de mi código
- 29. Generación de documentación de código fuente XMLDoc Delphi
- 30. Generar documentación de código HTML de un solo archivo