En cuanto a la denominación de C# para acrónimos, si estaba escribiendo una biblioteca relacionada con la API de Windows, ¿hay alguna convención fuerte hacia WindowsApi o WindowsAPI o solo es una preferencia personal?C# Convenciones de nomenclatura para acrónimos
Existe una convención, que especifica mayúsculas inicial, el resto minúsculas, para todos los acrónimos que tienen más de 2 caracteres de longitud. De ahí HttpContext y ClientID.
Su preferencia personal. Pero .NET usaría WindowsApi. Es similar a la denominación de TcpClient.
He oído que debe evitar las abreviaturas, por lo que se convertiría en WindowsApplicationProgrammingInterface, entonces.
más grave (la gente parece ser mis-leer lo anterior, a pesar de la cita más adelante), this page dice:
cualquier acrónimo de tres letras o más deben ser caso Pascal, no todos los casquillos.
Dado que API se considera un acrónimo bien conocido, el nombre WindowsApi es el que debe elegir si quiere seguir las instrucciones.
Las abreviaturas son correctas si son bien conocidas dentro del dominio. API es bien conocido dentro de la programación. –
+1. El libro de Pautas marco recomienda evitar abreviaturas o acrónimos o utilizar PascalCase. Sugeriría WindowsApi. Ejemplo del marco: Uri, UriBuilder HtmlDecode. – Skurmedel
@John: Sí, estaba siendo un poco irónico en eso. :) – unwind
Todo es solo preferencia personal (u organizacional). Mientras seas consecuente, estarás bien.
El propio .NET Framework usaría WindowsApi.
verificación Microsoft directrices oficiales de nomenclatura aquí Naming Guidelines
Ese documento es para .NET 1.1. –
No veo la diferencia que hace? No es como si hubieran cambiado las convenciones entre cada versión o algo. – Skurmedel
Existe una segunda edición del libro de pautas de diseño. No he comparado para determinar que no hay ningún cambio en el nombramiento. –
"Framework Design Guidelines" 2ª edición de Krzysztof Cwalina y Brad Abrams pp.40-42
3.1.2 Mayúsculas en acrónimos
DO capitalizar ambos caracteres en acrónimos de dos caracteres, excepto la primera palabra de un identificador de camello.
System.IO
public void StartIO(Stream ioStream)
DO mayúsculas sólo el primer carácter de siglas con tres o más caracteres, excepto la primera palabra de un identificador de camello entubado.
System.Xml
public void ProcessHtmlTag(string htmlTag)
NO capitalizar cualquiera de los caracteres de las siglas, cualquiera que sea su longitud, al comienzo de un identificador de camello entubado.
Eche un vistazo a FxCop también. Es una buena utilidad que ayudará con problemas como este.
Pregunta anterior, nueva respuesta.
De acuerdo con las "Reglas de Capitalización por siglas" sección del artículo MSDN Capitalization Conventions:
No capitalizar los dos personajes de acrónimos de dos caracteres, excepto la primera palabra de un identificador de camello entubado .
una propiedad denominada
DBRatees un ejemplo de una sigla corta (DB) usado como la primera palabra de un identificador de entubado-Pascal. Un parámetro denominadoioChanneles un ejemplo de un acrónimo corto (IO) utilizado como la primera palabra de un identificador camel-cassette.Escriba en mayúscula solo el primer carácter de los acrónimos con tres o más caracteres , excepto la primera palabra de un identificador camel-cased.
Una clase llamada
XmlWriteres un ejemplo de un acrónimo largo utilizado como primera palabra de un identificador de Pascal-cased. Un parámetro denominadohtmlReaderes un ejemplo de un acrónimo largo utilizado como la primera palabra de un identificador de camello .No coloque en mayúscula ninguno de los caracteres de ningún acrónimo, cualquiera que sea su longitud, al comienzo de un identificador camel-cased.
un parámetro denominado
xmlStreames un ejemplo de un largo acrónimo (xml) usado como la primera palabra de un identificador de camello-entubado. Un parámetro denominadodbServerNamees un ejemplo de un acrónimo corto (db) que se utiliza como la primera palabra de un identificador de camello.
Id - es capitalización preferible. "Otros dos términos que son de uso común están en una categoría por sí mismos, porque son abreviaturas comunes del argot. Las dos palabras" Aceptar "e" Id "(y deben incluirse como se muestra) son las excepciones a la guía que no las abreviaturas deben usarse en los nombres ". "Pautas de diseño del marco", segunda edición, p.44. –
Alguien notó que si ID significaba "Identificando Dato" (en lugar de "Identificador"), ID volvería a estar bien. Lo siento, Ok otra vez. – peterchen
@Sergey Teplyakov Las directrices de Microsoft dicen que se debe usar Pascal solo para abreviaturas de más de 2 caracteres. En el caso de ID y OK, todas las mayúsculas están bien, sin embargo HTML se convierte en Html. http://msdn.microsoft.com/en-us/library/141e06ef(v=VS.71).aspx – smdrager