MSTEST0025: use "Assert.Fail" em vez de uma declaração que sempre falha
| Propriedade | Valor |
|---|---|
| ID da regra | MSTEST0025 |
| Título | Use "Assert.Fail" em vez de uma declaração que sempre falha |
| Categoria | Criar |
| Correção interruptiva ou sem interrupção | Sem interrupção |
| Habilitado por padrão | Sim |
| Severidade padrão | Informações |
| Introduzido na versão | 3.4.0 |
| Há uma correção de código | Sim |
Causa
Esta regra gera um diagnóstico quando uma chamada de declaração resulta em uma condição que é sempre falsa.
Descrição da regra
Usar Assert.Fail em vez de uma chamada de declaração que sempre falha fornece uma intenção mais clara e uma melhor documentação para o código.
Quando você encontra uma declaração que sempre falha (por exemplo, Assert.IsTrue(false)), pode não ser imediatamente óbvio para quem lê o código o motivo da declaração estar lá ou qual condição está tentando verificar. Isso pode gerar confusão e desperdício de tempo para os desenvolvedores que se deparam com o código mais tarde.
Por outro lado, usar Assert.Fail permite que você forneça uma mensagem de falha personalizada, deixando claro o motivo da falha da declaração e qual condição ou cenário específico ela está abordando. Essa mensagem funciona como uma documentação para a intenção por trás da declaração, ajudando outros desenvolvedores a entender a finalidade da declaração sem a necessidade de analisar o código detalhadamente.
No geral, usar Assert.Fail promove clareza, documentação e facilidade de manutenção em sua base de código, sendo assim uma escolha mais acertada do que uma chamada de declaração que sempre resulta em falha.
Como corrigir violações
As chamadas para Assert.IsTrue, Assert.IsFalse, Assert.AreEqual, Assert.AreNotEqual, Assert.IsNull ou Assert.IsNotNull não podem gerar condições que sempre falham.
Quando suprimir avisos
Não recomendamos ignorar os avisos desta regra.
