Delen via


Hoofdletterconventies

Opmerking

Deze inhoud wordt opnieuw afgedrukt met toestemming van Pearson Education, Inc. uit Framework Design Guidelines: Conventies, idioom en patronen voor herbruikbare .NET-bibliotheken, 2e editie. Die editie werd in 2008 gepubliceerd en het boek is sindsdien volledig herzien in de derde editie. Sommige informatie op deze pagina is mogelijk verouderd.

De richtlijnen in dit hoofdstuk leggen een eenvoudige methode uit voor het gebruik van hoofdlettergebruik die, wanneer ze consistent worden toegepast, identificatoren voor typen, leden en parameters gemakkelijk leesbaar maken.

Hoofdlettergebruiksregels voor id's

Als u woorden in een id wilt onderscheiden, moet u de eerste letter van elk woord in de id hoofdletters geven. Gebruik geen onderstrepingstekens om woorden te onderscheiden, of überhaupt ergens in identificaties. Er zijn twee geschikte manieren om identificatoren met hoofdletters te beginnen, afhankelijk van het gebruik van de identificator:

  • PascalCasing

  • camelCasing

De PascalCasing-conventie, gebruikt voor alle id's behalve parameternamen, zet het eerste teken van elk woord in hoofdletters (inclusief acroniemen over twee letters in lengte), zoals wordt weergegeven in de volgende voorbeelden:

PropertyDescriptor HtmlTag

Er wordt een uitzondering gemaakt voor acroniemen van twee letters waarin beide letters met hoofdletters geschreven worden, zoals weergegeven in de volgende ID:

IOStream

De camelCasing-conventie, die alleen wordt gebruikt voor parameternamen, hoofdlettert het eerste teken van elk woord, behalve het eerste woord, zoals wordt weergegeven in de volgende voorbeelden. Zoals in het voorbeeld te zien is, worden bij een camelCase-id de tweeletterige afkortingen die ermee beginnen in kleine letters geschreven.

propertyDescriptor ioStream htmlTag

✔️ Gebruik PascalCasing voor alle namen van openbare leden, typen en naamruimten die bestaan uit meerdere woorden.

✔️ GEBRUIK camelCasing voor parameternamen.

In de volgende tabel worden de hoofdlettergebruiksregels voor verschillende typen id's beschreven.

Identificatie Lettertypegebruik Voorbeeld
Namespace Pascal namespace System.Security { ... }
Typologie Pascal public class StreamReader { ... }
gebruikersinterface Pascal public interface IEnumerable { ... }
Methode Pascal public class Object {
public virtual string ToString();
}
Vastgoed Pascal public class String {
public int Length { get; }
}
Gebeurtenis Pascal public class Process {
public event EventHandler Exited;
}
Veld Pascal public class MessageQueue {
public static readonly TimeSpan
InfiniteTimeout;
}
public struct UInt32 {
public const Min = 0;
}
Enum-waarde Pascal public enum FileMode {
Append,
...
}
Kenmerk Kameel public class Convert {
public static int ToInt32(string value);
}

Samengestelde woorden en algemene termen in hoofdletters

De meeste samengestelde termen worden behandeld als enkelvoudige woorden voor hoofdlettergebruik.

❌ GEBRUIK GEEN hoofdletters voor elk woord in zogenaamde closed-form samengestelde woorden.

Dit zijn samengestelde woorden die zijn geschreven als één woord, zoals eindpunt. Voor het gebruik van casingrichtlijnen behandelt u een gesloten samengesteld woord als één woord. Gebruik een huidige woordenlijst om te bepalen of een samengesteld woord in gesloten vorm is geschreven.

Pascal Kameel Niet
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

Hoofdlettergevoeligheid

Talen die op de CLR kunnen draaien, hoeven geen hoofdlettergevoeligheid te ondersteunen, hoewel sommige dat wel doen. Zelfs als uw taal het ondersteunt, kunnen andere talen die toegang tot uw framework hebben dat niet doen. API's die extern toegankelijk zijn, kunnen daarom niet uitsluitend van het gebruik van hoofdletters afhankelijk zijn om onderscheid te maken tussen twee namen in dezelfde context.

❌ GA ER NIET van uit dat alle programmeertalen hoofdlettergevoelig zijn. Dat zijn ze niet. Namen kunnen niet alleen per hoofdletter verschillen.

© Gedeelten 2005, 2009 Microsoft Corporation. Alle rechten voorbehouden.

Herdrukt door toestemming van Pearson Education, Inc. van Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition by Krzysztof Cwalina and Brad Abrams, gepubliceerd 22 oktober 2008 door Addison-Wesley Professional als onderdeel van de Microsoft Windows Development Series.

Zie ook