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.

Coding conventions allow programmers to have simple scripts or programs whose job is to process source code for some purpose other than compiling it into an executable. It is common practice to count the software size (Source lines of code) to track current project progress or establish a baseline for future project estimates.

Consistent coding standards can, in turn, make the measurements more consistent. Special tags within source code comments are often used to process documentation, two notable examples are javadoc and doxygen. The tools specify the use of a set of tags, but their use within a project is determined by convention.

Coding conventions simplify writing new software whose job is to process existing software. Use of static code analysis has grown consistently since the 1950s. Some of the growth of this class of development tools stems from increased maturity and sophistication of the practitioners themselves (and the modern focus on safety and security), but also from the nature of the languages themselves.

All software practitioners must grapple with the problem of organizing and managing a large number of sometimes complex instructions. For all but the smallest software projects, source code (instructions) are partitioned into separate files and frequently among many directories. It was natural for programmers to collect closely related functions (behaviors) in the same file and to collect related files into directories. As software development shifted from purely procedural programming (such as found in FORTRAN) towards more object-oriented constructs (such as found in C++), it became the practice to write the code for a single (public) class in a single file (the 'one class per file' convention).^[6][7] Java has gone one step further - the Java compiler returns an error if it finds more than one public class per file.

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