Qué reglas de StyleCop debo seguir al escribir una biblioteca de código abierto

Question

Actualmente estoy escribiendo un contenedor de código abierto para un objeto COM. Acabo de instalar StyleCop y ejecutarlo contra algunos de mis códigos, y como esperaba, lanzó una carga de advertencias (algunas de las cuales ya debería haber estado haciendo, por ejemplo, agregando "esto" a todas las llamadas y variables de métodos locales)

¿Cuántas de estas advertencias debo tratar de reducir? ¿Cuáles serían los mejores al escribir una biblioteca de código abierto?

Answer 1

La idea general con StyleCop es: Todos ellos :)

Las más opciones de apagar el valor menor StyleCop. tiene en hacer cumplir un formato de código único. Dicho esto, si no le gustan algunas de las opciones, entonces algunas opciones son mejores que ninguna, incluya el archivo de configuración de StyleCop con su código y otras personas que trabajen en él pueden usar la misma configuración.

Algunas de las configuraciones pueden parecer extrañas al principio si no estás familiarizado con StyleCop, pero habiéndolo usado durante dos años ahora dejo todas las opciones y nuestro equipo está bastante contento con los resultados.

También diría que si proporciona una biblioteca o un marco que use FxCop puede ser más importante que utilizar StyleCop.

Answer 2

La mayoría de los grandes proyectos de código abierto tienen sus propias pautas de estilo. Por ejemplo, aquí está el Apache C Language Style Guide.

Como inicio, sugiero que rastree las preguntas frecuentes para el proyecto del sistema operativo que le interesa y tómelo desde allí.

De todos modos, estoy seguro de que habrá mucha gente que rápidamente te dejará saber si estás rompiendo las reglas de estilo existentes a lo grande. ;-)

Tenga en cuenta todas las advertencias, generalmente intentan decirle algo útil. ¡No termine la "programación por coincidencia" (book excerpt) como dicen los programadores pragmáticos!

Editar: No me di cuenta de que este era su nuevo proyecto de sistema operativo. Mi error. De todos modos, me gustaría ojear algunos proyectos de SO ya existentes y ver si tienen alguna guía de estilo. Definitivamente, echa un vistazo al libro de Steve McConnell, Code Complete (Amazon link - sanitized para el script kiddie link nazis que deambulan por estos pasillos).

¡Lo que dije acerca de las advertencias y la "programación por coincidencia" todavía se aplica! (-:

HTH

aplausos,

Rob