Weaknesses of type CWE-1118
1 resultDocumentação insuficiente de técnicas de tratamento de erros
É a falta de documentação clara sobre como erros devem ser tratados em um componente ou API, deixando desenvolvedores sem orientação sobre casos de falha. Isso leva a tratamentos inconsistentes, ignorância de cenários críticos e código frágil em produção.
Uma biblioteca fornece uma função que pode falhar silenciosamente em 5 situações diferentes, mas o manual não documenta nenhuma delas nem menciona como validar entrada ou recuperar-se de erros. Desenvolvedores integram sem saber que precisam de try-catch ou verificações específicas, e a aplicação quebra em produção.
Documente explicitamente todos os cenários de erro possível, códigos de retorno/exceções esperadas, e forneça exemplos de tratamento correto. Use em paralelo testes que validem os caminhos de falha e considere gerar documentação automaticamente a partir de tipos/contratos de código.