Un documento de estándares de codificación es útil. Es lo más útil cuando es lo suficientemente corto para que cualquiera pueda recordar todo sin demasiados problemas y cuando no causa a nadie. demasiado dolor.
Cómo elige sangrar el código en su organización, o poner mayúsculas en los nombres, o implementar sus bucles, o comentar que su código no importa mucho; la parte útil es hacer que todos escriban un código que se parezca al de todos los demás.
- Evita tener que pasar un minuto recalibrando tu expectativa de dónde deben estar los frenos y así cada vez que mires el código de otra persona.
- Evita tener varios estilos de código diferentes en el mismo archivo.
- Quizás lo más importante, tener un estándar escrito evita los argumentos sobre las prácticas de codificación durante las revisiones de código.
Una vez más, lo que son los estándares no importa tanto como tener algún tipo de estándar simple y directo. Entonces, ponga a todos sus desarrolladores en una sala y permita que discutan sobre cuáles deberían ser los estándares. Esta reunión podría continuar indefinidamente, por lo que las reglas son:
- Cualquier cosa que no se haya decidido al final de la reunión será decidida por el gerente.
- La reunión terminará después de dos horas, o cuando alguien empiece a gritar o llorar, lo que ocurra primero.
- La norma completa se ajustará (¡en un tamaño de letra razonable!) en una hoja o dos de papel, a doble cara solo si es absolutamente necesario.
Considere adoptar alguien | else's | normas como punto de partida para su propia reunión de normas de codificación , o como una forma de evitar la reunión por completo.
Una vez acordado, los desarrolladores deben poder (y debe esperarse) controlarse ellos mismos. La desviación ocasional de la norma no debería ser un gran problema (e incluso podría ser justificable), pero la negativa obstinada a abandonar algún estilo personal favorito a favor de la norma debería dar lugar a una reubicación inmediata en la oficina con las tuberías de agua con fugas, o lo que sea .
Demian Brecht apunta a herramientas de pelusas. Estos son un complemento perfecto para un documento de estándares de codificación. Es simplemente bueno atenerse a los estándares de estilo de codificación; es importante atenerse a los estándares de codificación que se relacionan con prácticas peligrosas. Nadie más que el autor va a verificar que cada línea de código cumpla con el estándar de estilo, pero ciertamente debería considerar la creación de una herramienta de pelusas en el flujo de trabajo de su equipo para detectar automáticamente los posibles errores. Además, la propia herramienta puede codificar las prácticas aceptadas para que no tenga que enumerarlas todas individualmente en los estándares de codificación; simplemente especifique la configuración de la herramienta.
Nota: La idea de "estándares de codificación" no es exclusiva de la programación. Los "estándares de codificación" se utilizan en muchos campos, a veces dentro de una organización, más a menudo en toda una industria o profesión. Algunos ejemplos:
En cada caso (y en muchos otros), un profesional competente podría entender fácilmente el "código" que no cumple con el estándar esperado. ¿Por qué tantas industrias persisten en escribir requisitos detallados para documentos que ni siquiera necesitan ser analizados por un compilador? Porque el estilo importa . La presentación de información en un estilo estándar permite que el lector se enfoque completamente en el contenido, agilice la lectura y ayude a comprender, y reduce los errores.