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 mirada a las técnicas y herramientas utilizadas para documentar el código Python. Aunque el código Python está diseñado para ser legible, unos pocos comentarios bien colocados y accesibles a las personas pueden hacer mucho para ayudar a otros a entender el funcionamiento de tus programas. Como veremos, Python incluye tanto sintaxis como herramientas para facilitar la documentación. En concreto, el sistema PyDoc que aquí tratamos puede mostrar la documentación interna de un módulo como texto plano en un intérprete de comandos o como HTML en un navegador web.
Aunque se trata de un concepto relacionado con las herramientas, este tema se presenta aquí en parte porque tiene que ver con el modelo sintáctico de Python, y en parte como recurso para los lectores que se esfuerzan por comprender el conjunto de herramientas de Python. Para este último propósito, también ampliaré aquí 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 alturas del libro , probablemente estés empezando a darte cuenta de que Python ...
Get Aprender Python, 5ª Edición now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
