Documentacao de código

Prévia do material em texto

Documentação de código 
Qual e o principal objetivo da documentacao de codigo?
a) Facilitar a integracao com outras linguagens de programacao
b) Garantir que o codigo seja entendido e mantido por outras pessoas
c) Melhorar o desempenho do codigo em tempo de execucao
d) Reduzir o numero de erros durante o desenvolvimento
Resposta correta: b) Garantir que o codigo seja entendido e mantido por outras pessoas
A documentacao de codigo visa tornar o codigo mais legivel, explicando como ele funciona e como
deve ser mantido, de forma que qualquer desenvolvedor possa entende-lo facilmente.
O que e a documentacao inline no codigo?
a) Documentacao colocada fora do codigo, como arquivos de texto
b) Comentarios e anotacoes diretamente no codigo-fonte
c) Relatorios gerados automaticamente sobre o codigo
d) Documentacao sobre a arquitetura geral do sistema
Resposta correta: b) Comentarios e anotacoes diretamente no codigo-fonte
A documentacao inline refere-se aos comentarios diretamente no codigo-fonte, explicando o que
cada parte do codigo faz e por que foi feita daquela forma.
Qual e a vantagem de usar ferramentas automatizadas para gerar documentacao a partir do
codigo?
a) A documentacao sera criada automaticamente com base nas mudancas no codigo
b) A documentacao sera mais detalhada e precisa
c) Nao sera necessario manter a documentacao manualmente
d) A documentacao ficara mais facil de entender sem a necessidade de codificacao adicional
Resposta correta: a) A documentacao sera criada automaticamente com base nas mudancas no
codigo
Ferramentas como Javadoc (para Java) ou Sphinx (para Python) geram documentacao
automaticamente, baseando-se em anotacoes no codigo e, assim, garantem que ela esteja sempre
atualizada conforme o codigo evolui.
Por que e importante manter a documentacao de codigo atualizada?
a) Para evitar que o codigo se torne obsoleto
b) Para garantir que novas funcionalidades sejam adicionadas corretamente
c) Para garantir que outros desenvolvedores possam entender e modificar o codigo conforme
necessario
d) Para reduzir a complexidade do codigo
Resposta correta: c) Para garantir que outros desenvolvedores possam entender e modificar o
codigo conforme necessario
Manter a documentacao atualizada e crucial para garantir que qualquer desenvolvedor, seja atual
ou futuro, possa entender e modificar o codigo corretamente.
O que e um "README" em um repositorio de codigo?
a) Um arquivo que contem a documentacao de todas as bibliotecas utilizadas no codigo
b) Um arquivo que contem instrucoes basicas sobre o projeto, como instala-lo e usa-lo
c) Um arquivo que define os padroes de codificacao a serem seguidos no projeto
d) Um arquivo que contem apenas a lista de erros conhecidos do sistema
Resposta correta: b) Um arquivo que contem instrucoes basicas sobre o projeto, como instala-lo e
usa-lo
O README e fundamental para projetos open source ou de equipe, fornecendo informacoes
essenciais sobre o que o projeto faz, como configura-lo e usa-lo, e como contribuir para o projeto.
Qual e a diferenca entre documentacao tecnica e documentacao do usuario?
a) A documentacao tecnica foca em como os desenvolvedores usam o sistema, enquanto a
documentacao do usuario foca na experiencia do usuario final
b) A documentacao tecnica descreve apenas os erros conhecidos, enquanto a documentacao do
usuario explica as funcionalidades
c) A documentacao tecnica e voltada para desenvolvedores, enquanto a documentacao do usuario
e voltada para administradores do sistema
d) A documentacao tecnica aborda a experiencia do usuario, enquanto a documentacao do usuario
descreve o codigo-fonte
Resposta correta: a) A documentacao tecnica foca em como os desenvolvedores usam o sistema,
enquanto a documentacao do usuario foca na experiencia do usuario final
A documentacao tecnica e voltada para os desenvolvedores, explicando o funcionamento interno
do sistema, enquanto a documentacao do usuario e voltada para quem usara o sistema, explicando
como utiliza-lo.
Qual a principal vantagem de escrever boas mensagens de commit no Git?
a) As mensagens ajudam a automatizar o processo de deploy
b) As mensagens melhoram a legibilidade do codigo e ajudam a entender o historico de mudancas
c) As mensagens permitem que o codigo seja compartilhado em outras plataformas de codigo
d) As mensagens garantem que o codigo nao contenha bugs
Resposta correta: b) As mensagens melhoram a legibilidade do codigo e ajudam a entender o
historico de mudancas
Boas mensagens de commit tornam mais facil entender o proposito de cada alteracao no codigo,
facilitando a colaboracao e o rastreamento do historico do projeto.
Quando e mais adequado utilizar comentarios no codigo?
a) Quando o codigo e muito simples e nao necessita de explicacoes
b) Quando o codigo realiza operacoes triviais que nao precisam de explicacoes
c) Quando o codigo realiza operacoes complexas que exigem compreensao adicional para outros
desenvolvedores
d) Apenas quando o codigo esta causando erros
Resposta correta: c) Quando o codigo realiza operacoes complexas que exigem compreensao
adicional para outros desenvolvedores
Comentarios devem ser usados quando o codigo e complexo e precisa de explicacoes para garantir
que outros desenvolvedores possam entende-lo facilmente.
Qual e o papel dos diagramas na documentacao de codigo?
a) Eles ajudam a explicar visualmente a estrutura do codigo e os fluxos de dados, facilitando a
compreensao do sistema
b) Eles sao usados apenas para documentar bugs encontrados no codigo
c) Eles substituem completamente a necessidade de documentacao escrita
d) Eles sao utilizados apenas para otimizar o desempenho do codigo
Resposta correta: a) Eles ajudam a explicar visualmente a estrutura do codigo e os fluxos de dados,
facilitando a compreensao do sistema
Diagramas, como diagramas de classes e fluxogramas, ajudam a representar visualmente a
estrutura e os fluxos do sistema, tornando a documentacao mais clara e acessivel.
Qual a importancia de documentar as dependencias de um projeto?
a) Garantir que os desenvolvedores possam configurar o ambiente de desenvolvimento de forma
consistente
b) Reduzir o tempo de execucao do codigo
c) Facilitar o deploy para servidores de producao
d) Minimizar o numero de erros de integracao
Resposta correta: a) Garantir que os desenvolvedores possam configurar o ambiente de
desenvolvimento de forma consistente
Documentar as dependencias ajuda a garantir que todos os desenvolvedores tenham o mesmo
ambiente de desenvolvimento, o que evita problemas de configuracao e versoes incompativeis.
Quais informacoes devem ser incluidas na documentacao de uma API?
a) Apenas a lista de endpoints da API
b) Como autenticar na API, descricao de cada endpoint e exemplos de uso
c) Somente os erros que podem ocorrer durante o uso da API
d) Apenas o formato dos dados de resposta
Resposta correta: b) Como autenticar na API, descricao de cada endpoint e exemplos de uso
A documentacao de uma API deve incluir detalhes sobre autenticacao, a descricao de cada
endpoint (com metodos HTTP e parametros), e exemplos praticos para que outros desenvolvedores
possam usa-la facilmente.
O que e a documentacao "self-hosted"?
a) Documentacao que e gerada automaticamente e armazenada em um servidor externo
b) Documentacao que e criada e mantida dentro da propria aplicacao ou sistema
c) Documentacao em formato PDF, hospedada em servidores privados
d) Documentacao que e acessada somente por desenvolvedores da empresa
Resposta correta: b) Documentacao que e criada e mantida dentro da propria aplicacao ou sistema
A documentacao "self-hosted" e hospedada e mantida diretamente no proprio servidor ou
aplicacao, permitindo facil acesso e atualizacao.
O que significa "documentacao legivel" no contexto de codigo?
a) Codigo escrito de forma compacta e sem espacos desnecessarios
b) Codigo escrito de forma clara e compreensivel, com explicacoes quando necessario
c) Codigo otimizadopara ser o mais rapido possivel
d) Codigo com o maior numero possivel de funcoes reutilizaveis
Resposta correta: b) Codigo escrito de forma clara e compreensivel, com explicacoes quando
necessario
A documentacao legivel refere-se a escrever codigo e comentarios de forma que outros
desenvolvedores possam compreende-lo sem esforco, facilitando a manutencao e a colaboracao.
Qual e o papel da documentacao de codigo durante a manutencao de software?
a) Garantir que o codigo nunca sera alterado
b) Ajudar desenvolvedores a entender rapidamente o codigo e realizar modificacoes sem introduzir
erros
c) Substituir a necessidade de testes de unidade
d) Evitar que o codigo precise ser reescrito
Resposta correta: b) Ajudar desenvolvedores a entender rapidamente o codigo e realizar
modificacoes sem introduzir erros
Durante a manutencao, a documentacao ajuda a entender rapidamente como o codigo funciona,
facilitando a correcao de bugs e a implementacao de novas funcionalidades.
O que e uma "documentacao de codigo legivel" e como ela impacta a equipe de desenvolvimento?
a) Ela descreve os passos tecnicos necessarios para a execucao do codigo
b) Ela facilita a