- 10/22/2008
- 2 minutos para leer
-
-
K -
n -
B -
D -
n -
+10
-
Las directrices de este capítulo establecen un método sencillo para el uso de mayúsculas y minúsculas que, cuando se aplica consistentemente, hace que los identificadores de tipos, miembros y parámetros sean fáciles de leer.
Reglas de mayúsculas para los identificadores
Para diferenciar las palabras de un identificador, ponga en mayúsculas la primera letra de cada palabra del identificador. No utilice guiones bajos para diferenciar palabras, ni tampoco en ninguna parte de los identificadores. Hay dos maneras apropiadas de poner en mayúsculas los identificadores, dependiendo del uso del identificador:
-
PascalCasing
-
camelCasing
La convención PascalCasing, utilizada para todos los identificadores excepto los nombres de los parámetros, pone en mayúscula el primer carácter de cada palabra (incluyendo los acrónimos de más de dos letras), como se muestra en los siguientes ejemplos:
PropertyDescriptorHtmlTag
Se hace un caso especial para los acrónimos de dos letras en los que ambas letras van en mayúscula, como se muestra en el siguiente identificador:
IOStream
La convención camelCasing, utilizada sólo para los nombres de parámetros, pone en mayúscula el primer carácter de cada palabra excepto la primera, como se muestra en los siguientes ejemplos. Como el ejemplo también muestra, los acrónimos de dos letras que comienzan un identificador con camelCase están ambos en minúsculas.
propertyDescriptorioStreamhtmlTag
✔️ Usa PascalCasing para todos los miembros públicos, tipos y nombres de espacios de nombres que consisten en múltiples palabras.
✔️ Utilizar camelCasing para los nombres de parámetros.
La siguiente tabla describe las reglas de capitalización para los diferentes tipos de identificadores.
| Identificador | Casilla | Ejemplo |
|---|---|---|
| Espacio de nombres | Pascal | namespace System.Security { ... } |
| Tipo | Pascal | public class StreamReader { ... } |
| Interfaz | Pascal | public interface IEnumerable { ... } |
| Método | Pascal | public class Object { public virtual string ToString(); } |
| Propiedad | Pascal | public class String { public int Length { get; } } |
| Evento | Pascal | public class Process { public event EventHandler Exited; } |
| Campo | Pascal | public class MessageQueue { public static readonly TimeSpan InfiniteTimeout; } public struct UInt32 { public const Min = 0; } |
| Valor Enum | Pascal | public enum FileMode { Append, ... } |
| Parámetro | Camel | public class Convert { public static int ToInt32(string value); } |
Capitalización de palabras compuestas y términos comunes
La mayoría de los términos compuestos se tratan como palabras individuales a efectos de la capitalización.
❌ NO escriba en mayúsculas cada palabra en las llamadas palabras compuestas de forma cerrada.
Son palabras compuestas escritas como una sola palabra, como punto final. A efectos de las directrices sobre el uso de las mayúsculas, trate una palabra compuesta de forma cerrada como una sola palabra. Utilice un diccionario actual para determinar si una palabra compuesta está escrita en forma cerrada.
| Pascal | Camel | No |
|---|---|---|
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 |
Sensibilidad de mayúsculas y minúsculas
Los lenguajes que pueden ejecutarse en el CLR no están obligados a soportar lasensibilidad a las mayúsculas, aunque algunos lo hacen. Incluso si su lenguaje lo soporta, otros lenguajes que podrían acceder a su framework no lo hacen. Cualquier API que sea accesible externamente, por lo tanto, no puede confiar en las mayúsculas y minúsculas para distinguir entre dos nombres en el mismo contexto.
❌ NO asuma que todos los lenguajes de programación son sensibles a las mayúsculas y minúsculas. No lo son. Los nombres no pueden diferenciarse sólo por las mayúsculas y minúsculas.
Porciones © 2005, 2009 Microsoft Corporation. Todos los derechos reservados.
Reproducido con permiso de Pearson Education, Inc. de Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition de Krzysztof Cwalina y Brad Abrams, publicado el 22 de octubre de 2008 por Addison-Wesley Professional como parte de la Microsoft Windows Development Series.
Véase también
- Framework Design Guidelines
- Naming Guidelines