c# - reglas - Convenciones de nomenclatura: pautas para verbos/sustantivos y uso de la gramática inglesa
gramatica inglesa avanzada (7)
Además de las pautas de MSDN, existe un documento de estándares de codificación C # de IDesign de Juval Lowy que es bastante útil (no sé si / cuánto difiere de MSDN).
¿Alguien puede dirigirme a un sitio, o darme alguna sabiduría sobre cómo elegir nombres para interfaces, clases y quizás incluso métodos y propiedades relacionados con lo que hace ese objeto o método?
Esto es específicamente para el desarrollo de Microsoft, por lo que "doGet" al estilo de Java, etc., no se usa realmente, sin embargo, algunas reglas generales que cruzan las barreras del lenguaje deben existir (habría pensado).
Un ejemplo podría ayudar: Tengo 4 opciones de nombres para una interfaz:
IGroupedItem
IGroupableItem
IDataEntity
IGroupedEntity
Todos ellos contienen un adjetivo y el sustantivo, o solo un sustantivo. En cuanto al framework .NET, parece que debe haber algún tipo de conjunto de reglas para esto, para mantener la coherencia. Aparte de los verbos obvios para los métodos.
Editar: aunque el ejemplo es una interfaz, no lo estoy limitando a las interfaces. La pauta general es clases son sustantivos, métodos verbos, propiedades sustantivos. Supongo que lo que quiero decir es elección del sinónimo. Está tirando "Entidad" en todas partes mal
Este es el mismo material que la respuesta de Spodi, pero las Pautas de diseño de MSDN para los Desarrolladores de la Biblioteca de la clase son en su mayoría excelentes, que incluyen nombres y mucho, mucho más.
Hay un buen artículo haciendo que el código incorrecto parezca mal por Joel Spolsky. Habla sobre la convención de nombres no tan popular, pero muy útil.
Las interfaces son cosas que una clase es capaz de hacer. No es lo que es , sino lo que puede hacer .
IGroupableItem
Otros nombres describen qué cosas son o son demasiado vagas para ser útiles.
Específicamente, "IDataEntity" es en gran medida sin sentido. Después de todo, todo es una entidad de datos.
MSDN tiene un artículo sobre las Pautas de nomenclatura de interfaz que puede serle útil. Si desea las convenciones de nomenclatura de otras cosas además de las interfaces, junto con muchas otras pautas de nomenclatura y diseño, puede encontrarlo todo en MSDN también.
Mire los artículos de MSDN para las pautas de nombramiento. En breve:
- Use sustantivos para nombres de clases y nombres de propiedades (es obvio)
- Para nombres de interfaz, comience con I y use sustantivos y / o adjetivos para describir el comportamiento
- Use verbos para nombres de métodos para describir acción
Para su ejemplo - IGroupableItem.
Prueba esto....
Sitio principal: http://www.ssw.com.au/ssw/standards/Default.aspx
Reglas de código: http://www.ssw.com.au/ssw/Standards/Rules/RulestoBetterCode.aspx