Perché questo nome con un trattino basso non è conforme a CLS?

Question

Perché ottengo l'avviso del compilatore

non Identifier 'Logic.DomainObjectBase._isNew' è compatibile con CLS

per il seguente codice?

public abstract class DomainObjectBase 
{ 
    protected bool _isNew; 
} 

Answer 1

Dal Common Language Specification:

CLS-compliant compilatori di linguaggio devono seguire le regole di cui all'allegato 7 del Technical Report 15 della standard Unicode 3.0, che regola il set di caratteri che possono iniziare ed essere inclusi in identificatori . Questo standard è disponibile dal sito Web del Consorzio Unicode.

Se look this up:

Cioè, il primo carattere di un identificatore può essere una lettera maiuscola, minuscola, lettera Titlecase, lettera modificatore, altra lettera o numero di lettera. I caratteri successivi di un identificatore possono essere uno qualsiasi di questi, oltre a segni di non spaziatura, segni di spaziatura combinati, numeri decimali, punteggiature del connettore e codici di formattazione (come il segno con il simbolo di destra e di sinistra). Normalmente i codici di formattazione devono essere filtrati prima di memorizzare o confrontare gli identificatori.

Fondamentalmente, non è possibile avviare un identificatore con un carattere di sottolineatura - questo viola CLS conforme su un campo visibile (pubblico/protetto).

Answer 2

Il principale underscore concomitante con _isNew essendo visibile (cioè, non private).

Answer 3

È il trattino basso. Vedi questo article.

Answer 4

Poiché il nome del membro dati, _isNew, inizia con un trattino basso.

Answer 5

Un identificatore conforme a CLS non deve iniziare con un trattino di sottolineatura.

Answer 6

Il trattino basso causa il problema. La pratica comune è che il carattere di sottolineatura è riservato ai campi privati. i membri protetti/pubblici dovrebbero essere correttamente assegnati e nominati.

Ad esempio:

public abstract class DomainObjectBase{ 
    private bool _isNew; 
    protected bool IsNew { get { return _isNew; } set { _isNew = value;} } 
} 

O, se si desidera utilizzare 3.x e sbarazzarsi del campo privato:

public abstract class DomainObjectBase{ 
    protected bool IsNew { get; set; } 
} 

Answer 7

Il leader _ è non compatibile con CLS

Microsoft StyleCop analizzerà il codice e fornirà collegamenti ai documenti pertinenti che spiegano il motivo per cui non è conforme a CLS.

Answer 8

CLS compliance ha a che fare con l'interoperabilità tra le diverse lingue .NET. La proprietà non è conforme a CLS, poiché inizia con un carattere di sottolineatura ed è pubblica (nota: le proprietà protette in una classe pubblica sono accessibili dall'esterno dell'assieme).Anche se questo funzionerà se si accede alla proprietà da C#, potrebbe non essere accessibile se si accede da altri linguaggi .NET che non consentono i caratteri di sottolineatura all'inizio dei nomi di proprietà, quindi non è conforme a CLS.

hai trovato questo errore del compilatore, perché da qualche parte nel codice che avete etichettato l'assembly come compatibile con CLS con una linea simile a questa:

[assembly: CLSCompliant(true)] 

Visual Studio include questa riga nel file AssemblyInfo.cs che può essere trovato sotto Proprietà nella maggior parte dei progetti.

Per ovviare a questo errore è possibile:

1. Rinominare la vostra proprietà (consigliato):

   protected bool isNew; 
   

2. Impostare tutta la vostra assemblea per essere non compatibile con CLS:

   [assembly: CLSCompliant(false)] 
   

3. Aggiungi un attributo solo al tuo immobile:

   [CLSCompliant(false)] 
   protected bool _isNew; 
   

4. Modificare l'ambito della proprietà, in modo che non possa essere visualizzato all'esterno dell'assieme.

   private bool _isNew;