Fallos del tipo CWE-1118

1 resultado

Documentação insuficiente de técnicas de tratamento de erros

É quando o código implementa tratamento de erros, mas não documenta adequadamente como esses mecanismos funcionam ou como os erros devem ser tratados. Isso causa confusão para desenvolvedores que mantêm ou integram o código, levando a tratamentos incorretos de exceções e comportamentos inesperados em produção.

Ejemplo

Uma função retorna códigos de erro numéricos (0, -1, -2, etc.) sem especificar em comentários ou documentação o que cada código significa. Outro desenvolvedor assume uma convenção diferente e ignora o erro -1 pensando que é sucesso, causando falha silenciosa.

Cómo mitigar

Documente explicitamente todos os erros que uma função pode gerar, seus códigos ou exceções, e como devem ser tratados. Use comentários, docstrings, READMEs ou especificações de API que detalhem o fluxo de erro esperado e as consequências de não tratá-los corretamente.