CA1014: Marcar assemblies com CLSCompliantAttribute
| Propriedade | valor |
|---|---|
| ID da regra | CA1014 |
| Cargo | Marcar assemblies com CLSCompliantAttribute |
| Categoria | Desenho |
| A correção está quebrando ou não quebrando | Sem quebra |
| Habilitado por padrão no .NET 8 | Não |
Causa
Um assembly não tem o System.CLSCompliantAttribute atributo aplicado a ele.
Descrição da regra
A Common Language Specification (CLS) define restrições de nomenclatura, tipos de dados e regras às quais os assemblies devem estar em conformidade se forem usados em linguagens de programação. Um bom design determina que todas as montagens indiquem explicitamente a conformidade CLS com CLSCompliantAttributeo . Se o atributo não estiver presente em um assembly, o assembly não será compatível.
É possível que um assembly compatível com CLS contenha tipos ou membros de tipo que não são compatíveis.
Como corrigir violações
Para corrigir uma violação dessa regra, adicione o atributo ao assembly. Em vez de marcar todo o conjunto como não compatível, você deve determinar qual tipo ou membros do tipo não são compatíveis e marcar esses elementos como tal. Se possível, você deve fornecer uma alternativa compatível com CLS para membros não compatíveis, para que o público mais amplo possível possa acessar todas as funcionalidades do seu assembly.
Quando suprimir avisos
Não suprima um aviso desta regra. Se você não quiser que o assembly seja compatível, aplique o atributo e defina seu valor como false.
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 CA1014
// The code that's violating the rule is on this line.
#pragma warning restore CA1014
Para desabilitar a regra para um arquivo, pasta ou projeto, defina sua severidade como none no arquivo de configuração.
[*.{cs,vb}]
dotnet_diagnostic.CA1014.severity = none
Para obter mais informações, consulte Como suprimir avisos de análise de código.
Exemplo
O exemplo a seguir mostra um assembly que tem o atributo aplicado que o System.CLSCompliantAttribute declara compatível com CLS.
[assembly:CLSCompliant(true)]
namespace DesignLibrary {}
<assembly:CLSCompliant(true)>
Namespace DesignLibrary
End Namespace
