Convenții de capitalizare

  • 10/22/2008
  • 2 minute de citit
    • K
    • n
    • .

    • B
    • D
    • n
    • +10

Legitimările din acest capitol prezintă o metodă simplă de utilizare a cazurilor care, atunci când este aplicată în mod consecvent, face ca identificatorii pentru tipuri, membri și parametri să fie ușor de citit.

Reguli de capitalizare pentru identificatori

Pentru a diferenția cuvintele dintr-un identificator, scrieți cu majusculă prima literă a fiecărui cuvânt din identificator. Nu folosiți sublinieri pentru a diferenția cuvintele sau, de altfel, nicăieri în identificatori. Există două moduri adecvate de a scrie cu majuscule identificatorii, în funcție de utilizarea identificatorului:

  • PascalCasing

  • camelCasing

Convenția PascalCasing, utilizată pentru toți identificatorii, cu excepția numelor de parametri, scrie cu majuscule primul caracter al fiecărui cuvânt (inclusiv acronimele cu o lungime mai mare de două litere), așa cum se arată în următoarele exemple:

PropertyDescriptorHtmlTag

Se face un caz special pentru acronimele de două litere în care ambele litere sunt scrise cu majusculă, așa cum se arată în următorul identificator:

IOStream

Convenția camelCasing, utilizată numai pentru numele parametrilor, scrie cu majusculă primul caracter al fiecărui cuvânt, cu excepția primului cuvânt, așa cum se arată în următoarele exemple. După cum arată și exemplul, acronimele din două litere care încep un identificator camel-cased sunt amândouă minuscule.

propertyDescriptorioStreamhtmlTag

✔️ Folosiți PascalCasing pentru toate numele de membri publici, tipuri și spații de nume care constau din mai multe cuvinte.

✔️ DO folosiți camelCasing pentru numele de parametri.

Tabelul următor descrie regulile de utilizare a majusculelor pentru diferite tipuri de identificatori.

.

.

Identificator Casing Exemplu
Namespace Pascal namespace System.Security { ... }
Type Pascal public class StreamReader { ... }
Interface Pascal public interface IEnumerable { ... }
Method Pascal public class Object {
public virtual string ToString();
}
Property Pascal public class String {
public int Length { get; }
}
Event Pascal . public class Process {
public event EventHandler Exited;
}
Field Pascal public class MessageQueue {
public static readonly TimeSpan
InfiniteTimeout;
}.
public struct UInt32 {
public const Min = 0;
}
Valoare Enum Pascal public enum FileMode {
Append,
...
....
}
Parameter Camel public class Convert {
public static int ToInt32(string value);
}

Capitalizarea cuvintelor compuse și a termenilor comuni

Majoritatea termenilor compuși sunt tratați ca și cum ar fi cuvinte simple în scopul capitalizării.

❌ NU scrieți cu majusculă fiecare cuvânt în așa-numitele cuvinte compuse cu formă închisă.

Este vorba de cuvinte compuse scrise ca un singur cuvânt, cum ar fi endpoint. În scopul orientărilor privind scrierea cu majuscule, tratați un cuvânt compus cu formă închisă ca pe un singur cuvânt. Utilizați un dicționar curent pentru a determina dacă un cuvânt compus este scris în formă închisă.

.

Pascal Camel Nu
BitFlag bitFlag Bitflag
Callback callback CallBack
Canceled canceled Cancelled
DoNot doNot Don't
Email email EMail
Endpoint endpoint EndPoint
FileName fileName Filename
Gridline gridline GridLine
Hashtable hashtable HashTable
Id id ID
Indexes indexes Indices
LogOff logOff LogOut
LogOn logOn LogIn
Metadata metadata MetaData, metaData
Multipanel multipanel MultiPanel
Multiview multiview MultiView
Namespace namespace NameSpace
Ok ok OK
Pi pi PI
Placeholder placeholder PlaceHolder
SignIn signIn SignOn
SignOut signOut SignOff
UserName userName Username
WhiteSpace whiteSpace Whitespace
Writable writable Writeable

Sensibilitate la majuscule

Limbajele care pot rula pe CLR nu sunt obligate să suporte majuscule și minuscule.sensibilitatea la majuscule, deși unele o fac. Chiar dacă limbajul dvs. o suportă, alte limbaje care ar putea accesa cadrul dvs. nu o fac. Prin urmare, orice API-uri care sunt accesibile din exterior nu se pot baza doar pe majuscule și minuscule pentru a distinge între două nume în același context.

❌ NU presupuneți că toate limbajele de programare sunt sensibile la majuscule și minuscule. Ele nu sunt. Numele nu se pot deosebi doar prin majuscule și minuscule.

Porțiuni © 2005, 2009 Microsoft Corporation. Toate drepturile rezervate.

Reimprimat cu permisiunea Pearson Education, Inc. din Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition de Krzysztof Cwalina și Brad Abrams, publicat la 22 octombrie 2008 de Addison-Wesley Professional ca parte a Microsoft Windows Development Series.

Vezi și

  • Framework Design Guidelines
  • Naming Guidelines

.

Lasă un răspuns

Adresa ta de email nu va fi publicată.