Articles

Capitalization Conventions

admin0
  • 10/22/2008
  • 2 minutes to read
    • K
    • n
    • B
    • D
    • n
    • +10

Tässä luvussa esitetyissä ohjeissa esitellään yksinkertainen menetelmä tapauksen käyttämiseen, joka, johdonmukaisesti sovellettuna tekevät tyyppien, jäsenten ja parametrien tunnisteista helppolukuisia.

Tunnisteiden isoja kirjaimia koskevat säännöt

Tunnisteen sanojen erottamiseksi toisistaan kirjoitetaan tunnisteen jokaisen sanan ensimmäinen kirjain isolla alkukirjaimella. Älä käytä alleviivauksia sanojen erottamiseen tai muutenkaan missään tunnisteissa. Tunnisteiden suuraakkosiin on kaksi sopivaa tapaa riippuen tunnisteen käytöstä:

  • PascalCasing

  • camelCasing

PascalCasing-konventiossa, jota käytetään kaikissa tunnisteissa parametrien nimiä lukuun ottamatta, jokaisen sanan ensimmäinen kirjain kirjoitetaan suuraakkosin (mukaan lukien yli kahden kirjaimen pituiset akronyymit), kuten seuraavissa esimerkeissä näkyy:

PropertyDescriptorHtmlTag

Erikoistapauksena ovat kaksikirjaimiset akronyymit, joissa molemmat kirjaimet kirjoitetaan isolla alkukirjaimella, kuten seuraavissa tunnisteissa näkyy:

IOStream

CamelCasing-käytäntö, jota käytetään vain parametrinimissä, kirjoittaa isolla alkukirjaimella jokaisen sanan ensimmäisen merkin, lukuun ottamatta ensimmäistä sanaa, kuten seuraavissa esimerkeissä näkyy. Kuten esimerkki myös osoittaa, kaksikirjaimiset lyhenteet, jotka alkavat camel-casing-tunnisteen, ovat molemmat pieniä kirjaimia.

propertyDescriptorioStreamhtmlTag

✔️ KÄYTÄ PascalCasing-käytäntöä kaikille julkisille jäsen-, tyyppi- ja nimiavaruusnimille, jotka koostuvat useista sanoista.

✔️ DO use camelCasing for parameter names.

Seuraavassa taulukossa kuvataan erityyppisten tunnisteiden isokirjoitussäännöt.

Identifier Casing Example
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;
}
Kenttä Pascal public class MessageQueue {
public static readonly TimeSpan
InfiniteTimeout;
}
public struct UInt32 {
public const Min = 0;
}
Enum value Pascal public enum FileMode {
Append,
...
}
Parametri Kameli public class Convert {
public static int ToInt32(string value);
}
}

Yhdyssanojen ja yleiskielisten termien isolla kirjaimella merkitseminen

Vähäisimpiä yhdyssanoja kohdellaan isolla kirjaimella merkitsemisessä yksittäisinä sanoina.

❌ ÄLÄ kirjoita jokaista sanaa isolla alkukirjaimella niin sanotuissa suljetuissa yhdyssanoissa.

Nämä ovat yhdyssanoja, jotka kirjoitetaan yhdeksi sanaksi, kuten endpoint. Käsittele suljetussa muodossa olevaa yhdyssanaa suuraakkosohjeissa yhtenä sanana. Käytä nykyistä sanakirjaa määrittääksesi, onko yhdyssana kirjoitettu suljetussa muodossa.

Pascal Camel Ei
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

Suuraakkosherkkyys

Kieliltä, jotka voivat toimia CLR:llä, ei vaadita suuraakkoset-tukea.herkkyyttä, vaikka jotkut tukevatkin. Vaikka kielesi tukisi sitä, muut kielet, jotka saattavat käyttää kehystäsi, eivät tue sitä. Kaikki API:t, joihin on pääsy ulkopuolelta, eivät siis voi luottaa pelkkään isoon ja pieneen kirjaimeen erottaakseen kaksi nimeä toisistaan samassa kontekstissa.

❌ ÄLÄ oleta, että kaikki ohjelmointikielet ovat isojen ja pienten kirjainten herkkiä. Ne eivät ole. Nimet eivät voi erota toisistaan pelkän ison ja pienen alkukirjaimen perusteella.

Teksti © 2005, 2009 Microsoft Corporation. Kaikki oikeudet pidätetään.

Painettu Pearson Education, Inc:n luvalla teoksesta Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition by Krzysztof Cwalina and Brad Abrams, julkaistu 22.10.2008 Addison-Wesley Professionalin julkaisemana osana Microsoft Windows Development Series -julkaisusarjaa.

Katso myös

  • Kehysten suunnitteluohjeet
  • Nimeämisohjeet

.

Vastaa

Sähköpostiosoitettasi ei julkaista.