Considerando que a documentação de referência é imprescindív...

Próximas questões
Com base no mesmo assunto
Q1797823 Programação
Considerando que a documentação de referência é imprescindível para garantir a usabilidade de uma API, julgue o próximo item.
A documentação de uma biblioteca de funções de uma API construída em linguagem procedural deve incluir uma descrição das estruturas de dados das quais depende; uma descrição das propriedades de cada uma das funções; e eventuais restrições de acessibilidade e visibilidade.
Alternativas

Gabarito comentado

Confira o gabarito comentado por um dos nossos professores

Alternativa correta: C - certo

A questão aborda um aspecto extremamente importante no desenvolvimento e uso de APIs (Application Programming Interfaces), que é a necessidade de uma boa documentação. Vamos entender por que a afirmativa está correta:

Documentação de Estruturas de Dados: Em uma API que utiliza uma linguagem procedural, as funções frequentemente operam sobre dados. A documentação deve, portanto, incluir descrições claras das estruturas de dados utilizadas, pois isso é fundamental para que os desenvolvedores entendam como interagir com a API.

Descrição das Funções: Cada função deve ter uma descrição das suas propriedades, incluindo o que ela faz, quais argumentos espera receber, o que retorna e, muito importante, quais são os efeitos colaterais que podem ocorrer ao chamá-la. Isso ajuda a garantir que as funções sejam usadas de maneira correta e eficiente.

Restrições de Acessibilidade e Visibilidade: Em muitos casos, certas partes de uma API podem ser restritas ou projetadas para uso interno apenas. Por isso, é crucial que a documentação especifique quaisquer restrições de acessibilidade e visibilidade. Isso pode incluir níveis de acesso necessário para diferentes funções ou partes da API, bem como quais métodos são considerados privados ou protegidos.

Portanto, a afirmação da questão está correta, pois uma documentação completa e detalhada é essencial para a usabilidade de uma API, e deve abranger todos os pontos destacados: estruturas de dados, descrições das funções, além das restrições de acessibilidade e visibilidade. Uma documentação bem elaborada serve tanto para facilitar o uso da API por outros desenvolvedores quanto para fornecer uma referência rápida para manutenção e atualizações futuras.

Clique para visualizar este gabarito

Visualize o gabarito desta questão clicando no botão abaixo

Comentários

Veja os comentários dos nossos alunos

JUSTIFICATIVA - CERTO.

“6.1 Documentação de referência da API

A documentação de referência para uma API é parte intrínseca de qualquer API, e sem ela a API é inutilizável. Cada aspecto da API, não importa o quão trivial, deve ser declarado explicitamente. Quando uma API documenta uma biblioteca de funções em uma linguagem procedural, ela deve incluir:

• uma descrição de todas as estruturas de dados de que depende

• uma descrição de todas as assinaturas de funções, incluindo:

• nomes de funções

• nomes de parâmetros de função (quando aplicável) e tipos

• tipo de retorno para as funções

• para cada parâmetro, se o parâmetro for possivelmente modificável dentro da função 

• uma descrição do tratamento de qualquer condição de erro

• pré e pós-condições ou invariantes

• de forma mais geral, como o estado muda após a execução da função

• possíveis efeitos colaterais

• qualquer restrição de acessibilidade ou visibilidade.” 

Linguagem declarativa: Dar uma ordem, mas sem detalhe das operações.

Linguagem Procedural: Dar uma ordem, mas fornece todos dado para a execução da operação. Passo a Passo.

CERTO

"A documentação de uma biblioteca de funções de uma API construída em linguagem procedural deve incluir uma descrição das estruturas de dados das quais depende; uma descrição das propriedades de cada uma das funções; e eventuais restrições de acessibilidade e visibilidade." (C)

___

LINGUAGEM PROCEDURAL:

(1) Uma API construída em linguagem procedural é uma API não orientada a objetos, ou seja, não tenta trazer objetos do mundo real para se tornar parte do código. 

(2) A linguagem procedural contém uma ordem de instruções, funções e comandos para completar uma tarefa ou programa computacional.

(3) As especificações da linguagem procedural são apresentadas em formato legível em livros, e-books e manuais.

Pergunta sincera: isso não seria assunto para analista em TI? sei que devemos nos adequar a banca mas esse assunto não tem nada a ver com carreiras policiais

Clique para visualizar este comentário

Visualize os comentários desta questão clicando no botão abaixo