Capítulo 15. O Interlúdio da Documentação
Este trabalho foi traduzido com recurso a IA. Agradecemos o teu feedback e comentários: translation-feedback@oreilly.com
Essa parte do livro termina com uma breve olhada nas técnicas e ferramentas usadas pra documentar código Python. Embora o código Python seja relativamente fácil de ler por si só, alguns comentários bem colocados e acessíveis podem ajudar muito os outros a entender como seus programas funcionam — especialmente quando o código fica maior do que a maioria neste livro. Como você verá, o Python inclui sintaxe e ferramentas para facilitar a documentação. Em particular, o sistema Pydoc abordado aqui pode renderizar a documentação de um arquivo de código como texto simples em um REPL interativo ou HTML em um navegador.
Embora esse tópico esteja parcialmente relacionado a ferramentas, ele é apresentado aqui porque envolve o modelo de sintaxe do Python e fornece um recurso para os leitores que têm dificuldade em entender o conjunto de ferramentas do Python. Para esse último objetivo, este capítulo também expande as dicas de documentação apresentadas pela primeira vez no Capítulo 4. Como de costume, como este capítulo encerra sua parte, ele também termina com alguns avisos sobre armadilhas comuns e um conjunto de exercícios para esta parte do texto, além do questionário do capítulo.
Fontes de documentação do Python
A esta altura do livro, você provavelmente está começando a perceber que o Python vem com uma quantidade incrível ...
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