Estándares de código... ¿para qué?

Detalles

Publicado: Viernes, 26 Marzo 2010 14:17

Como desarrolladores, nuestro entregable es el código fuente, es lo que producimos, y por lo tanto debemos hacer que se vea bien. Pero, ¿qué significa "bien"? ¿Cómo debería verse? Podríamos armar debates interminables sobre el tema, y los resultados nos desilusionarían. No existe algo como el Mejor Estilo De Codificación.

Sin embargo, existe un estilo de codificación uniforme. En un equipo independiente, todo el código que produce debería tener un estilo consistente. Todo el tiempo. Sin excepciones. Y eso quiere decir sin excepciones de ningún tipo.

En general parecería que no se necesita mucha explicación: un estilo de código consistente es intuitivamente Algo Bueno, ¿no? Desafortunadamente hay algunos desarrolladores que quieren más explicaciones. Y por supuesto: ¿quién no querría argumentos cuando se le pide cambiar sus hábitos?

Déjenme hacer énfasis en recodar que el estilo de código y la legibilidad y la consistencia es verdaderamente importante; lo cual difiere con la forma de pensar de algunos desarrolladores: si funciona y el diseño es bueno, el código es bueno. Esto sólo funciona cuando sos la única persona trabajando en el proyecto; ni bien se suman más personas resulta una buena idea hacer que todo el código sea uniforme, y mantener el código legible y documentado de forma adecuada.

El principal motivo es que ayuda a la propiedad colectiva de código (por ejemplo, haciendo que otras personas no se sientan intimidadas por tocar el código para arreglar errores, o que asuman que el código es una porquería porque se ve desprolijo, o evitar el complejo de la ventana rota: si ya está feo, para que arreglarlo). Hacer que el código se vea igual también ayuda a detectar inconsistencias, como parámetros o funciones que deberían ser privados para están públicos, código de debug que en realidad es productivo, comentarios que están mal ubicados o son confusos, etc.

Es una combinación de pequeños detalles, pero que al juntarlos agregan un valor sustancial a la base de código compartida.

¿Necesitan más motivos?

Traducido de Coding standards, but why?, por Gertjan Zwartjes.