Capítulo 15. El interludio de la documentación
Este trabajo se ha traducido utilizando IA. Agradecemos tus opiniones y comentarios: translation-feedback@oreilly.com
Esta parte del libro concluye con una breve mirada a las técnicas y herramientas utilizadas para documentar el código Python. Aunque el código Python es comparativamente legible por sí mismo, unos pocos comentarios bien colocados y accesibles a las personas pueden hacer mucho para ayudar a otros a entender el funcionamiento de tus programas, especialmente cuando el código crece más que la mayoría en este libro. Como verás, Python incluye tanto sintaxis como herramientas para facilitar la documentación. En concreto, el sistema Pydoc que se describe aquí puede mostrar la documentación de un archivo de código como texto sin formato en un REPL interactivo, o como HTML en un navegador.
Aunque este tema está en parte relacionado con las herramientas, se presenta aquí porque tiene que ver con el modelo sintáctico de Python y proporciona un recurso a los lectores que se esfuerzan por comprender el conjunto de herramientas de Python. Con este último propósito, este capítulo también amplía las indicaciones sobre documentación que se dieron por primera vez en el Capítulo 4. Como es habitual, dado que este capítulo cierra su parte, también termina con algunas advertencias sobre errores comunes y un conjunto de ejercicios para esta parte del texto, además de su cuestionario del capítulo.
Fuentes de documentación de Python
A estas ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access