¿Cuáles son los estándares de "formateo" de C#?

Question

En C# (. NET), ¿cuáles son los estándares normales de "formateo"?

Por ejemplo, para nombres de parámetros, hasta ahora he notado camelCase sin prefijo, ¿verdad? Para nombres de objetos, camelCase y sin prefijo tampoco, ¿verdad?

Para espacios de nombres, clases, funciones y propiedades, la primera letra de la palabra está en mayúscula y no hay prefijo, ¿está bien (de nuevo)?

¿Cómo se formatea el objeto "temporal"?

Ejemplo:

namespace TestNamespace 
{ 
    class MyOwnCoolClass 
    { 
     MyOwnCoolClass(int length, BinaryWriter writer) 
     { 
      BinaryWriter tempbw = new BinaryWriter(length); 
      return tempbw; 
     } 
    } 
} 

(Nota: Este código no es válido, ya sé, es sólo para demostrar formato). Gracias!

Answer 1

Si usa StyleCop, obtendrá buena consistencia con el Microsoft .NET Design Guidelines for Developing Class Libraries. StyleCop también aplica varias cosas adicionales como el espaciado, el ordenamiento de elementos en un archivo y el nombramiento de elementos de código no públicos.

Answer 2

Las pautas completas de Microsoft se pueden encontrar en Class Design Guidelines. Es antiguo, pero todavía no he encontrado nada actualizado en MSDN, y creo que sigue siendo el estándar de las recomendaciones

Answer 3

me gustaría echar un vistazo a la siguiente Coding Practices.

Cubre prácticamente todo lo que veo en la mayor parte del código de C que leo ... incluyendo el prefijo elementos de interfaz de usuario. Yo personalmente no lo sigo al pie de la letra pero te da una buena idea del estándar general y de las buenas/malas prácticas.

Answer 4

Existen referencias a los estándares de codificación de Microsoft. Visual Studio 2005 y 2008 tienen un motor de análisis de código integrado que lo guiará a través de estos estándares de codificación y también le indicará algunas mejores prácticas. Haga clic derecho en su proyecto y haga clic en "Ejecutar análisis de código en el proyecto".

Cuando se detecta una porción de código no válido o menos preferido, no solo lo advertirá, sino que lo dirigirá a un recurso de ayuda en el sitio de FxCop.

Answer 5

MSDN: Naming Guidelines

que tienden a seguir la forma de codificar el marco .NET así que mi código es compatible con .NET Framework.

Mi única preferencia personal es nombrar las variables de clase que utilizo el prefijo "m_" antes de cada variable como private int m_count.

Answer 6

Puede usar la combinación de StyleCop y FxCop (o el Análisis de código incorporado para VS2008 Pro) para herramientas y Framework Design Guidelines.

Answer 7

Escribí these guidelines en el último año usando varias pautas de MSFT y otras pautas ampliamente aceptadas. Es posible que desee comprobarlo, también tiene otras cosas, como la configuración de proyectos y otras cosas, pero todas las directrices de nombres también están allí.

editar: Me di cuenta de que esta es una versión anterior, tengo una nueva versión que he estado escribiendo durante un tiempo y contiene muchas cosas buenas, pero no está hecho. Sin embargo, actualizaré esta publicación cuando esté publicada.