Documentao de cdigo

Text Material Preview

Documentação de código 
O que e documentacao de codigo?
a) O processo de escrever testes automatizados para o codigo
b) O ato de descrever a logica e a funcionalidade do codigo de forma compreensivel para outras
pessoas
c) A criacao de imagens e diagramas que ilustram o funcionamento do codigo
d) O registro de todos os erros que ocorrem durante a execucao do codigo
Resposta correta: b) O ato de descrever a logica e a funcionalidade do codigo de forma
compreensivel para outras pessoas
Explicacao: A documentacao de codigo e essencial para tornar o codigo mais legivel,
compreensivel e facil de manter por outras pessoas, incluindo outros desenvolvedores e ate mesmo
voce no futuro.
Qual das alternativas descreve melhor a documentacao inline (ou comentarios no codigo)?
a) Um arquivo separado que contem descricoes sobre o projeto
b) Comentarios explicando trechos especificos do codigo dentro do proprio arquivo de codigo
c) A criacao de videos que explicam a estrutura do codigo
d) O uso de diagramas UML para mostrar a arquitetura do sistema
Resposta correta: b) Comentarios explicando trechos especificos do codigo dentro do proprio
arquivo de codigo
Explicacao: A documentacao inline ou comentarios no codigo sao utilizados para explicar trechos
de codigo, como o funcionamento de uma funcao ou a logica por tras de uma decisao especifica.
Isso ajuda quem estiver lendo o codigo a entender rapidamente o que esta acontecendo.
Qual e o principal beneficio da documentacao de codigo?
a) Reduzir o numero de linhas de codigo
b) Aumentar a complexidade do sistema
c) Facilitar a manutencao e o entendimento do codigo por outros desenvolvedores
d) Melhorar a performance do codigo
Resposta correta: c) Facilitar a manutencao e o entendimento do codigo por outros
desenvolvedores
Explicacao: A principal funcao da documentacao de codigo e tornar o codigo mais facil de entender
e manter, especialmente em equipes de desenvolvimento ou quando o codigo precisa ser
modificado no futuro.
Qual e o formato mais comum de documentacao de codigo em linguagens de programacao como
Python e Java?
a) Arquivos de texto simples
b) Arquivos PDF
c) Docstrings ou comentarios estruturados
d) Planilhas Excel
Resposta correta: c) Docstrings ou comentarios estruturados
Explicacao: Em muitas linguagens de programacao, como Python, e comum utilizar docstrings, que
sao strings documentando funcoes, classes e modulos. Esses comentarios estruturados permitem
que ferramentas automaticas extraiam informacoes e gerem documentacao.
Quando e mais apropriado usar a documentacao de codigo em vez de deixar o codigo
"autoexplicativo"?
a) Sempre que o codigo for curto e simples
b) Quando o codigo for complexo ou envolver multiplas interacoes
c) Somente em projetos de grande porte
d) Apenas quando o codigo for escrito em uma linguagem desconhecida
Resposta correta: b) Quando o codigo for complexo ou envolver multiplas interacoes
Explicacao: Quando o codigo e complexo, envolve varias partes interconectadas ou utiliza logicas
complicadas, a documentacao e essencial para garantir que outros desenvolvedores consigam
entender e manter o sistema corretamente.
Qual e a diferenca entre documentacao de codigo e documentacao do projeto?
a) A documentacao de codigo descreve o projeto como um todo, enquanto a documentacao do
projeto descreve o codigo
b) A documentacao de codigo e focada em explicar a implementacao de funcionalidades, enquanto
a documentacao do projeto foca nos requisitos e arquitetura do sistema
c) A documentacao do projeto e mais tecnica, enquanto a documentacao de codigo e voltada para
usuarios finais
d) Nao ha diferenca entre as duas
Resposta correta: b) A documentacao de codigo e focada em explicar a implementacao de
funcionalidades, enquanto a documentacao do projeto foca nos requisitos e arquitetura do sistema
Explicacao: A documentacao de codigo detalha como o codigo funciona, enquanto a documentacao
do projeto abrange aspectos como requisitos, arquitetura, fluxos de trabalho e decisoes de design.
Qual a principal vantagem de utilizar ferramentas como Javadoc ou Sphinx para gerar a
documentacao?
a) Permitir que o codigo seja executado mais rapidamente
b) Automatizar o processo de geracao da documentacao a partir de comentarios estruturados no
codigo
c) Gerar um numero maior de comentarios no codigo
d) Melhorar a seguranca do codigo
Resposta correta: b) Automatizar o processo de geracao da documentacao a partir de comentarios
estruturados no codigo
Explicacao: Ferramentas como Javadoc (Java) e Sphinx (Python) permitem gerar documentacao
automaticamente a partir de comentarios no codigo, o que economiza tempo e garante que a
documentacao esteja sempre atualizada.
O que e uma documentacao "automatica"?
a) Documentacao gerada sem a intervencao de ferramentas externas
b) Documentacao criada automaticamente com base na execucao de testes unitarios
c) Documentacao gerada por ferramentas que extraem informacoes do codigo-fonte, como
comentarios e docstrings
d) Documentacao feita sem qualquer tipo de interacao humana
Resposta correta: c) Documentacao gerada por ferramentas que extraem informacoes do
codigo-fonte, como comentarios e docstrings
Explicacao: A documentacao automatica e criada por ferramentas que extraem informacoes de
docstrings ou comentarios estruturados no codigo, gerando documentacao em diversos formatos,
como HTML ou PDF, sem a necessidade de criacao manual.
Qual a importancia de manter a documentacao do codigo atualizada?
a) Para garantir que os desenvolvedores nao precisem mais estudar o codigo
b) Para melhorar o desempenho do codigo
c) Para que a documentacao continue a refletir as mudancas no codigo e se mantenha util
d) Para reduzir a quantidade de codigo escrito
Resposta correta: c) Para que a documentacao continue a refletir as mudancas no codigo e se
mantenha util
Explicacao: A documentacao de codigo deve ser atualizada sempre que o codigo for alterado. Se
nao for mantida em sincronia com o codigo, a documentacao pode se tornar obsoleta e dificil de
usar.
Quando voce deve adicionar comentarios no codigo?
a) Sempre que o codigo estiver funcionando corretamente
b) Apenas quando o codigo for complexo e dificil de entender
c) Somente para explicar o que o codigo esta fazendo, e nao como ele faz
d) Apenas quando o codigo for escrito por outra pessoa
Resposta correta: b) Apenas quando o codigo for complexo e dificil de entender
Explicacao: Comentarios sao uteis quando o codigo e complexo, contem logicas complicadas ou
utiliza padroes que podem nao ser imediatamente obvios para outros desenvolvedores. Em casos
de codigo simples, os comentarios podem ser desnecessarios.
Qual e a principal desvantagem de escrever muitos comentarios no codigo?
a) Aumento da complexidade do codigo
b) Aumento do tempo de execucao do codigo
c) Diminuicao da legibilidade do codigo e dificuldade para identificar erros
d) Maior risco de desatualizacao e informacoes incorretas na documentacao
Resposta correta: d) Maior risco de desatualizacao e informacoes incorretas na documentacao
Explicacao: Comentarios excessivos podem se tornar desatualizados a medida que o codigo muda,
o que pode levar a confusao. E importante que os comentarios sejam relevantes, atualizados e nao
sobrecarreguem o codigo.
O que e a documentacao "do usuario"?
a) Documentacao voltada para descrever a logica do codigo
b) Documentacao voltada para usuarios finais, explicando como utilizar o software ou sistema
c) Documentacao explicando como otimizar o codigo
d) Documentacao para auxiliar desenvolvedores na criacao de codigo
Resposta correta: b) Documentacao voltada para usuarios finais, explicando como utilizar o
software ou sistema
Explicacao: A documentacao do usuario e voltada para guiar os usuarios finais sobre como utilizar
o software, suas funcionalidades e como solucionar problemas comuns.
O que e a pratica do "self-documenting code"?
a) A pratica de usar ferramentasautomaticas para gerar a documentacao
b) A pratica de escrever codigo tao claro e legivel que nao ha necessidade de comentarios
adicionais
c) A pratica de criar documentacao separada, sem comentar o codigo
d) A pratica de escrever documentacao de codigo em arquivos PDF
Resposta correta: b) A pratica de escrever codigo tao claro e legivel que nao ha necessidade de
comentarios adicionais
Explicacao: O conceito de "self-documenting code" se refere a escrever codigo de forma que sua
intencao e funcionamento sejam evidentes sem a necessidade de comentarios extensivos. Isso
pode ser alcancado atraves de bons nomes de variaveis, funcoes e estrutura.
Qual e a melhor pratica para escrever boas documentacoes de codigo?
a) Escrever documentacao apenas para funcoes e metodos complexos
b) Escrever a documentacao no inicio do desenvolvimento, sem esperar ate o final
c) Escrever documentacao curta e vaga para evitar desperdicio de tempo
d) Escrever documentacao clara, objetiva e sempre atualizada, incluindo exemplos de uso
Resposta correta: d) Escrever documentacao clara, objetiva e sempre atualizada, incluindo
exemplos de uso
Explicacao: A documentacao deve ser bem escrita, facil de entender e manter. Incluir exemplos de
uso ajuda outros desenvolvedores a entender como utilizar as funcionalidades corretamente.
O que significa "documentacao orientada ao desenvolvimento"?
a) Documentacao focada em como utilizar a interface do usuario
b) Documentacao que explica como o codigo foi desenvolvido, sua arquitetura e os motivos das
escolhas feitas
c) Documentacao que e escrita apenas no final do projeto
d) Documentacao criada para