Questão Q1797823

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

Certo

Errado

Comentários

JUSTIFICATIVA - CERTO.
“6.1 Documentação de referência da API
A documentação de referência para uma API é parte intrínseca de qualquer API, e sem ela a API é inutilizável. Cada aspecto da API, não importa o quão trivial, deve ser declarado explicitamente. Quando uma API documenta uma biblioteca de funções em uma linguagem procedural, ela deve incluir:
• uma descrição de todas as estruturas de dados de que depende
• uma descrição de todas as assinaturas de funções, incluindo:
• nomes de funções
• nomes de parâmetros de função (quando aplicável) e tipos
• tipo de retorno para as funções
• para cada parâmetro, se o parâmetro for possivelmente modificável dentro da função
• uma descrição do tratamento de qualquer condição de erro
• pré e pós-condições ou invariantes
• de forma mais geral, como o estado muda após a execução da função
• possíveis efeitos colaterais
• qualquer restriçã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.

SóProvas

Continue usando...

O que está incluso