CA1200: Evite usar tags cref com um prefixo
| Propriedade | valor |
|---|---|
| ID da regra | CA1200 |
| Cargo | Evite usar tags cref com um prefixo |
| Categoria | Documentação |
| A correção está quebrando ou não quebrando | Sem quebra |
| Habilitado por padrão no .NET 8 | Não |
Causa
A tag cref em um comentário de documentação XML usa um prefixo.
Descrição da regra
O atributo cref em uma tag de documentação XML significa "referência de código". Ele especifica que o texto interno da marca é um elemento de código, como um tipo, método ou propriedade. Evite usar cref tags com prefixos, pois isso impede que o compilador verifique referências. Ele também impede que o ambiente de desenvolvimento integrado (IDE) do Visual Studio encontre e atualize essas referências de símbolo durante refatoração. É recomendável usar a sintaxe completa sem prefixos para fazer referência a nomes de símbolos em tags cref.
Como corrigir violações
Para corrigir uma violação dessa regra, remova o cref prefixo da tag. Por exemplo, os dois trechos de código a seguir mostram uma violação da regra e como corrigi-la:
// Violates CA1200
/// <summary>
/// Type <see cref="T:C" /> contains method <see cref="F:C.F" />
/// </summary>
class C
{
public void F() { }
}
// Does not violate CA1200
/// <summary>
/// Type <see cref="C" /> contains method <see cref="F" />
/// </summary>
class C
{
public void F() { }
}
Quando suprimir avisos
É seguro suprimir esse aviso se a referência de código precisar usar um prefixo porque o tipo referenciado não pode ser encontrado pelo compilador. Por exemplo, se uma referência de código fizer referência a um atributo especial na estrutura completa, mas o arquivo for compilado em relação à estrutura portátil, você poderá suprimir esse aviso.
Suprimir um aviso
Se você quiser apenas suprimir uma única violação, adicione diretivas de pré-processador ao seu arquivo de origem para desativar e, em seguida, reativar a regra.
#pragma warning disable CA1200
// The code that's violating the rule is on this line.
#pragma warning restore CA1200
Para desabilitar a regra para um arquivo, pasta ou projeto, defina sua severidade como none no arquivo de configuração.
[*.{cs,vb}]
dotnet_diagnostic.CA1200.severity = none
Para obter mais informações, consulte Como suprimir avisos de análise de código.
