Convenciones de codificación

Las convenciones de codificación son un conjunto de directrices 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 suelen abarcar la organización de archivos, la indentación , los comentarios , las declaraciones , las sentencias , 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. Son directrices para la calidad estructural del software . Se recomienda encarecidamente a los programadores de software que sigan estas directrices para ayudar a mejorar la legibilidad de su código fuente y facilitar el mantenimiento del software . Las convenciones de codificación solo son aplicables a los mantenedores humanos y revisores por pares de un proyecto de software. Las convenciones pueden estar formalizadas en un conjunto documentado de reglas que sigue todo un equipo o empresa, ^{[ 1 ]} o pueden ser tan informales como las prácticas de codificación habituales de un individuo. Las convenciones de codificación no son impuestas por los compiladores .

Reducir el costo del mantenimiento del software es la razón más citada para seguir las convenciones de codificación. En la sección introductoria sobre las convenciones de código para el lenguaje de programación Java, Sun Microsystems ofrece el siguiente razonamiento: ^{[ 2 ]}

Las convenciones de código son importantes para los programadores por varias razones:

• Entre el 40% y el 80% del costo total de un software a lo largo de su vida útil se destina a mantenimiento. ^{[ 3 ]}
• Prácticamente ningún software recibe mantenimiento durante toda su vida útil por parte de su autor original.
• Las convenciones de codificación mejoran la legibilidad del software, lo que permite a los ingenieros comprender el código nuevo de forma más rápida y exhaustiva.
• Si distribuyes tu código fuente como un producto, debes asegurarte de que esté tan bien empaquetado y limpio como cualquier otro producto que crees.

Las convenciones de codificación permiten a los programadores tener scripts o programas sencillos cuya función es procesar el código fuente para un propósito distinto al de compilarlo en un ejecutable. Es práctica común contar el tamaño del software ( líneas de código fuente ) para realizar un seguimiento del progreso del proyecto actual o establecer una base para las estimaciones de proyectos futuros .

Los estándares de codificación consistentes pueden, a su vez, hacer que las mediciones sean más consistentes. Las etiquetas especiales dentro de los comentarios del código fuente se utilizan a menudo para procesar la documentación; dos ejemplos notables son javadoc y doxygen . Estas herramientas especifican el uso de un conjunto de etiquetas, pero su uso dentro de un proyecto viene determinado por convención.

Las convenciones de codificación simplifican la escritura de nuevo software cuya función es procesar el software existente. El uso del análisis estático de código ha crecido de forma constante desde la década de 1950. Parte de este crecimiento se debe a la mayor madurez y sofisticación de los propios profesionales (y al enfoque actual en la seguridad ), pero también a la naturaleza de los lenguajes de programación en sí .

Todos los profesionales del software deben lidiar con el problema de organizar y administrar una gran cantidad de instrucciones, a veces complejas. Para casi todos los proyectos de software, excepto los más pequeños, el código fuente (instrucciones) se divide en archivos separados y, frecuentemente, entre muchos directorios . Era natural que los programadores agruparan funciones (comportamientos) estrechamente relacionadas en el mismo archivo y agruparan archivos relacionados en directorios. A medida que el desarrollo de software pasó de la programación puramente procedimental (como la que se encuentra en FORTRAN ) hacia construcciones más orientadas a objetos (como las que se encuentran en C++ ), se convirtió en práctica escribir el código para una sola clase (pública) en un solo archivo (la convención de "una clase por archivo"). ^{[ 6 ] [ 7 ]} Java ha ido un paso más allá: el compilador de Java devuelve un error si encuentra más de una clase pública por archivo.

Una convención en un lenguaje puede ser un requisito en otro. Las convenciones de lenguaje también afectan a los archivos fuente individuales. Cada compilador (o intérprete) utilizado para procesar el código fuente es único. Las reglas que un compilador aplica al código fuente crean estándares implícitos. Por ejemplo, el código Python tiene una indentación mucho más consistente que, digamos, Perl, porque el espacio en blanco (indentación) es realmente significativo para el intérprete. Python no utiliza la sintaxis de llaves que Perl usa para delimitar funciones. Los cambios en la indentación sirven como delimitadores. ^{[ 8 ] [ 9 ]} Tcl , que usa una sintaxis de llaves similar a Perl o C/C++ para delimitar funciones, no permite lo siguiente, lo que parece bastante razonable para un programador de C:

establecer i = 0 mientras { $i < 10 } { poner "$i al cuadrado = [expr $i*$i]" incrementar i }

La razón es que en Tcl, las llaves no se usan solo para delimitar funciones como en C o Java. De manera más general, las llaves se usan para agrupar palabras en un solo argumento. ^{[ 10 ] [ 11 ]} En Tcl, la palabra while toma dos argumentos, una condición y una acción . En el ejemplo anterior, a while le falta su segundo argumento, su acción (porque Tcl también usa el carácter de nueva línea para delimitar el final de un comando).

Existen numerosas convenciones de codificación; consulte Estilo de codificación para ver numerosos ejemplos y explicaciones. Las convenciones de codificación comunes pueden abarcar las siguientes áreas:

• Convenciones para comentarios
• convenciones de estilo de sangría
• convenciones de longitud de línea
• Convenciones de nomenclatura
• Prácticas de programación
• Principios de programación
• convenciones de estilo de programación

Los estándares de codificación incluyen el estándar de codificación CERT C , MISRA C y High Integrity C++ .

• Comparación de lenguajes de programación (sintaxis)
• Notación húngara
• Estilo de sangría
• Lista de herramientas para el análisis estático de código
• Lista de filosofías de desarrollo de software
• MISRA
• Estilo de programación
• Métricas de software
• Calidad del software
• Las reglas del poder de 10
• Configuración del editor