5
Mi chiedevo se è possibile utilizzare POD (plain old documentation) con Python? E come dovrei farlo?È possibile utilizzare POD (plain old documentation) con Python?
A
risposta
1
Non sembra essere un modo direttamente supportato per utilizzare POD in linea in un file Python. Tuttavia, i moduli Python (inclusa la libreria standard Python) sono documentati usando reStructuredText. Di solito questo viene fatto usando Sphinx, che produce la documentazione da docstrings formattati in reStructuredText. Sfinge e prima sono state specificamente progettate per riempire una nicchia simile al POD.
Perché ne hai bisogno. Python ha il proprio formato docstring che viene interpretato da 'pydoc'. Se si utilizza POD, gli utenti del modulo necessitano di uno strumento per leggerlo. Sei sicuro che questo è quello che vuoi? Se vuoi solo documentare il tuo codice, usa la docstring di python. – javex