19
Cosa c'è là fuori su convenzioni e strumenti per documentare il codice sorgente Python?per python
A
risposta
9
Epydoc è anche un buon strumento per la documentazione del codice sorgente, e gestisce corsi di riferimenti incrociati, i moduli, le variabili, ecc, in HTML, PDF, LaTeX. Disegna anche dei bei diagrammi di ereditarietà delle classi. È usato da numerosi progetti open-source, quindi è sviluppato abbastanza attivamente.
35
Convenzioni: PEP 257 e PEP 8. nota, che docstring possono essere scritti in reStructuredText
strumenti per la generazione di documentazione: per esempio Sphinx
6
E 'molto bello per mettere documentazione del codice nel codice stesso. Vedi:
16
Innanzitutto, inserire commenti nelle proprie docstring utilizzando il formato RestructuredText.
In secondo luogo, ottenere sphinx.
In terzo luogo, creare un indice che utilizza lo autodoc extension.
Quindi, eseguire Sphinx per ottenere una documentazione davvero bella.
1
utilizzando doxypy filter con doxygen è una buona cosa anche
Problemi correlati
- 1. Python * per potenziare :: python :: object
- 2. Equivalente rubino per Python per/
- 3. Python 2.7 o Python 3 (per velocità)?
- 4. Analizzatore Python per linguaggio simile a Python
- 5. __decorated__ per decoratori Python
- 6. database per Python ritorto
- 7. VisualVM equivalente per Python
- 8. Python per iOS interprete
- 9. PHP per programmatori Python?
- 10. configurazione .vimrc per Python
- 11. mod_python per python 2.7
- 12. Correttore ortografico per Python
- 13. Bluetooth per Python 2.7?
- 14. Passport.js equivalente per Python?
- 15. Multithreading per Python Django
- 16. Driver python per postgresql
- 17. Script Python per NetLogo?
- 18. nosql db per python
- 19. OpenCL per Python
- 20. Codifica Python per pipe.communicate
- 21. pyserial per Python 2.7.2
- 22. Python regex per intero?
- 23. Istogramma equalizzazione per Python
- 24. modi per eseguire python
- 25. Progetti per imparare Python
- 26. Directory Walker per Python
- 27. Python FTP per iPad
- 28. Parfor per Python
- 29. Lodash per Python?
- 30. algoritmo tfidf per python