Profesor: Ing. Matías Vallerga Ayudante: Lic. Cristian Kenny Estilo de Programación
Definición También conocido como: Estándares de código Convención de código Convenciones o reglas utilizadas al escribir código fuente Convenciones universales vs. Particulares De acuerdo al lenguaje, grupo de programadores, empresa, proyecto, etc. En general especificadas en un documento formal
Objetivos Proveer una estructura de código fácil de leer Garantizar un estilo similar facilitando la revisión del código Facilitar lectura y comprensión del código Familiarizar al grupo de programadores con el estilo Flexibilizar / independizar el desarrollo
Lineamientos generales Nomenclatura (nombres significativos) Indentación / Sangría / Sangrado Espaciado Comentarios
Nomenclatura Nombres deben ser auto-explicativos respecto a su propósito Ayudan a la autodocumentación Si la nomenclatura es pobre, se dificulta la lecutra y comprension del código Variables compuestas por 2 o más palabras: Lower Camel Case (miVariableNumerica) Upper Camel Case (MiVariableNumerica) Uso de guión bajo (mi_variable_numerica) mivariablenumerica NO! Nota: Sólo en caso de variables genéricas, como por ej. índices y algunos contadores, se podrán utilizar las variables del tipo i, j, k, etc.
Nomenclatura II Ej. get a b c if a < 24 and b < 60 and c < 60 return true else return false get horas minutos segundos if horas < 24 and minutos < 60 and segundos < 60 return true else return false
Indentación Posibilita tener una buena visibilidad del diseño o estructura de un programa Muestra claramente las líneas que se encuentran subordinadas a otras líneas
Indentación II if(horas < 24 && minutos < 60 && segundos < 60) { return true; } else { return false; } if(horas<24&&minutos<60&&segundos<60){return true;} else{return false;}
Espaciado Al igual que en la indentación, un buen uso de los espacios, facilita la comprensión y lectura del código fuente Algunas reglas a seguir: Separar sección declarativa de enunciados ejecutables mediante linea en blanco Utilizar un espacio antes y después de un operador binario (+, -, etc.) No dejar espacio al utlizar operadores unarios (++, --, etc.) Línea en blanco antes y después de estrucutras de control (si, mientras, etc.) Un enunciado por línea En caso de enunciados muy largos, elegir un punto apropiado de corte (ej. una coma) o de ser posible, simplificarlo en dos o más enunciados Tabulador vs. Espacios
Espaciado II int cuenta; for(cuenta=0;cuenta<10;cuenta++){printf("%d",cuenta*cuenta+cuenta);} int cuenta; for (cuenta = 0; cuenta < 10; cuenta++) { printf("%d", cuenta * cuenta + cuenta); }
Comentarios Herramienta muy útil para documentar el código Sirven para aclarar el funcionamiento del código Especialmente importante en secciones de código complicadas e inusuales Algunos tipos: Línea simple Multi-línea Importante su ubicación! (dependiente de su longitud) Línea superior Misma línea Indentados al mismo nivel del objeto descripto Aplica a variables, funciones, procedimientos, etc.