Las convenciones de codificación son un conjunto de pautas para un lenguaje de programación específico que recomiendan el estilo , las prácticas y los métodos de programación para cada aspecto de un programa escrito en ese lenguaje. Estas convenciones generalmente cubren la organización de archivos, la sangría , los comentarios , las declaraciones , los espacios en blanco , las convenciones de nomenclatura , las prácticas de programación, los principios de programación, las reglas generales de programación , las mejores prácticas arquitectónicas, etc. Estas son pautas para la calidad estructural del software . programadores de softwareSe recomienda encarecidamente seguir estas pautas para ayudar a mejorar la legibilidad de su código fuente y facilitar el mantenimiento del software . Las convenciones de codificación solo se aplican a los mantenedores humanos y revisores pares de un proyecto de software. Las convenciones pueden formalizarse en un conjunto documentado de reglas que sigue todo un equipo o empresa, [1] o pueden ser tan informales como las prácticas habituales de codificación de un individuo. Los compiladores no aplican las convenciones de codificación .
Reducir el costo del mantenimiento del software es la razón más citada para seguir las convenciones de codificación. En su introducción a las convenciones de código para el lenguaje de programación Java, Sun Microsystems proporciona la siguiente justificación: [2]
La revisión por pares del software implica con frecuencia la lectura del código fuente. Este tipo de revisión por pares es principalmente una actividad de detección de defectos . Por definición, solo el autor original de un fragmento de código ha leído el archivo fuente antes de enviar el código para su revisión. El código que está escrito usando pautas consistentes es más fácil de entender y asimilar para otros revisores, lo que mejora la eficacia del proceso de detección de defectos.
Incluso para el autor original, el software codificado de forma coherente facilita el mantenimiento. No hay garantía de que una persona recuerde la justificación precisa de por qué se escribió un código en particular mucho después de que se escribió originalmente. Las convenciones de codificación pueden ayudar. El uso constante de espacios en blanco mejora la legibilidad y reduce el tiempo que lleva comprender el software.
Cuando las convenciones de codificación se han diseñado específicamente para producir código de alta calidad y luego se han adoptado formalmente, se convierten en estándares de codificación. Los estilos específicos, independientemente de si se adoptan comúnmente, no producen automáticamente un código de buena calidad.
La gestión de la complejidad incluye el siguiente principio básico: minimizar la cantidad de código escrito durante el desarrollo del proyecto. Esto evita trabajo innecesario, lo que evita costos innecesarios, tanto iniciales como posteriores. Esto se debe simplemente a que si hay menos código, es menos trabajo no solo crear la aplicación, sino también mantenerla.