Convención de nomenclatura para un diccionario de C#

Question

¿Cómo nombramos una variable de diccionario?

Digamos que en mi método tengo Dictionary<string, List<string>> dictionary;, donde las claves del dictionary son nombres de países y los valores son listas de nombres de provincia/estado. ¿Cómo debo cambiar el nombre a dictionary?

Sé que podemos crear una clase Country para este ejemplo. Pero por favor no menciones esta alternativa porque estoy pensando en una buena convención de nombres aquí.

Answer 1

ProvincesByCountry 

Answer 2

utilizo sobre todo uno de estos:

• CountryToStatesDictionary
• CountryToStatesMap
• CountryToStatesMapping

Answer 3

provincias, provinceMap, provinceDictionary

Todos vienen a la mente. Me gusta ProvinceMapa mi yo. Si es un campo miembro, agregaría un prefijo "m_", como en "m_provinceMap".

Answer 4

me gusta XtoYMap o YFromX.

Answer 5

Nombrar siempre es contextual. Entonces, en este caso específico, es apropiado algún nombre que especifique el mapeo de país a estado.

si esto era sólo un dispositivo para un bucle dentro de un contexto más amplio y luego se descarta, que normalmente sólo tiene que ir con un tipo corto var temp como ...

var dict = GetCountryStateMapping(); 
foreach(var item in dict) 
{ 
    //Something.... 
} 

Answer 6

ProvincesByCountry no es lo suficientemente explícita, ya que suena como mapear países a provincias de uno a uno. Al acceder a ProvincesByCountry ["Alemania"] Me esperaba asumir que un valor es un objeto en lugar de una lista de objetos.

Mi patrón personal es similar:

[Plural of a noun describing the value]By[Singular of a noun describing the key] 

Sin embargo, si un sustantivo que describe el valor es plural, por su naturaleza, entonces yo uso el postfix matrices, o listas, al igual que en Inglés se puede 't realmente "pluralizar" un plural. Yo personalmente siempre se adhieren a las matrices , independientemente de la aplicación real de IEnumerable o IEnumerable < T> que estoy usando, se que Lista, o matriz o lo que sea.

En su caso se convierte en:

ProvinceArraysByCountry 

Explica lo que es con precisión científica.

Aplico esta regla recursivamente si hay diccionarios como valores. El orden de acceso va en reversa al orden de las palabras en el nombre.Imagine que agrega planetas:

ProvinceArraysByCountryByPlanet["Earth"]["Germany"][0] = "Bavaria" 
ProvinceArraysByCountryByPlanet["Earth"]["Germany"][1] = "Rhineland-Palatinate" 

Y finalmente, el último pequeño golpe aquí. Si dicho diccionario mapea las propiedades del objeto y los objetos mismos, entonces dejo fuera la palabra que describe el objeto en la sección clave. Esto es lo que quiero decir:

NodesByIndex[node.Index] = node; // - Do 
NodesByNodeIndex[node.Index] = node; // - Don't 

que utilizan este patrón incondicionalmente lo cual es bueno, ya que deja absolutamente ningún espacio para la conjetura. Con es que genera nombres bastante largos a veces. Pero no tengo idea de cómo tener siempre nombres explícitos, pero siempre cortos. Siempre tienes que comprometerte. Y es, por supuesto, una cuestión de gusto.

Este patrón no funciona (o al menos le rompería el cerebro) cuando las claves también son diccionarios o cuando tiene una lista de diccionarios de listas de diccionarios o alguna otra cosa loca y exótica. Pero no recuerdo haber tenido tantos niveles de anidación, así que estoy contento con eso.