Estilo de programación

El estilo de sangría puede ayudar al lector de diversas maneras, como por ejemplo, a identificar el flujo de control y los bloques de código. En algunos lenguajes de programación, la sangría se utiliza para delimitar bloques de código y, por lo tanto, no es una cuestión de estilo. En lenguajes que ignoran los espacios en blanco, la sangría puede afectar la legibilidad.

Por ejemplo, formateado con un estilo de uso común:

Si ( horas < 24 && minutos < 60 && segundos < 60 ) { return true ; } else { return false ; }

Podría decirse que tiene un formato deficiente:

Si ( horas < 24 && minutos < 60 && segundos < 60 ) { devolver verdadero ; } de lo contrario { devolver falso ; }

Si ( horas < 24 && minutos < 60 && segundos < 60 ) devolver verdadero ;de lo contrario, devolver falso ;

Si horas < 24 y minutos < 60 y segundos < 60 entonces devolver verdadero, de lo contrario devolver falso .

Si horas < 24 y minutos < 60 y segundos < 60 : devolver Verdadero; de lo contrario : devolver Falso

Sea c_1 = 1 y c_2 = 2 en f x y = c_1 * x + c_2 * y

sea ​​{ c_1 = 1 ; c_2 = 2 } en f x y = c_1 * x + c_2 * y

La función \ verb + isValidDate + prueba si la fecha es válida \ begin { code } isValidDate :: Date -> Bool isValidDate date = hh >= 0 && mm >= 0 && ss >= 0 && hh < 24 && mm < 60 && ss < 60 donde ( hh , mm , ss ) = fromDate date \ end { code } observe que en este caso la función sobrecargada es \ verb + fromDate :: Date -> ( Int , Int , Int ) +.

La función isValidDate comprueba si la fecha es válida.> isValidDate :: Date -> Bool > isValidDate fecha = hh >= 0 && mm >= 0 && ss >= 0 > && hh < 24 && mm < 60 && ss < 60 > donde ( hh , mm , ss ) = fromDate fechaobserve que en este caso la función sobrecargada es fromDate :: Date -> ( Int , Int , Int ) .

Algunos programadores consideran valioso alinear verticalmente los elementos similares (como en una tabla, en columnas), argumentando que esto puede hacer más evidentes los errores tipográficos.

Por ejemplo, no alineado:

$search = array ( 'a' , 'b' , 'c' , 'd' , 'e' ); $replacement = array ( 'foo' , 'bar' , 'baz' , 'quux' );$valor = 0 ; $otrovalor = 1 ; $otrovalor adicional = 2 ;

alineado:

$search = array ( 'a' , 'b' , 'c' , 'd' , 'e' ); $replacement = array ( 'foo' , 'bar' , 'baz' , 'quux' );$valor = 0 ; $otrovalor = 1 ; $otrovalor adicional = 2 ;

A diferencia del código no alineado, el código alineado implica que los valores de búsqueda y reemplazo están relacionados, ya que tienen elementos correspondientes. Dado que hay un valor más para la búsqueda que para el reemplazo, si se trata de un error, es más probable que se detecte mediante una inspección visual.

Entre las desventajas citadas de la alineación vertical se incluyen:

• Dependencias entre líneas que generan carga de mantenimiento. Por ejemplo, si se agrega un valor de columna largo que requiere una columna más ancha, entonces todas las líneas de la tabla deben modificarse (para mantener el formato tabular), lo que es un cambio mayor que conlleva más esfuerzo para revisar y comprender el cambio posteriormente.
• Fragilidad: si un programador no formatea correctamente la tabla al realizar un cambio, el resultado es un código visualmente desordenado y más difícil de leer que un código sin alinear. Operaciones de refactorización sencillas, como cambiar el nombre de las variables, pueden dañar el formato.
• El mayor esfuerzo de mantenimiento puede desalentar a un programador a realizar un cambio beneficioso, como mejorar el nombre de un identificador, ya que hacerlo requeriría un esfuerzo de formato significativo.
• Requisito de utilizar fuentes de ancho fijo, no fuentes proporcionales.

Mantener la alineación puede facilitarse mediante una herramienta que proporcione soporte (por ejemplo, para tabulaciones elásticas ), aunque esto crea una dependencia de dichas herramientas.

Como ejemplo, operaciones de refactorización simples para cambiar el nombre de "$replacement" a "$r" y de "$anothervalue" a "$a" dan como resultado:

$search = array ( 'a' , 'b' , 'c' , 'd' , 'e' ); $r = array ( 'foo' , 'bar' , 'baz' , 'quux' );$valor = 0 ; $a = 1 ; $otrovalor = 2 ;

Con un formato no alineado, estos cambios no tienen un efecto tan drástico, inconsistente o indeseable:

$search = array ( 'a' , 'b' , 'c' , 'd' , 'e' ); $r = array ( 'foo' , 'bar' , 'baz' , 'quux' );$valor = 0 ; $a = 1 ; $otrovalor = 2 ;

Un lenguaje de formato libre ignora los caracteres de espacio en blanco : espacios, tabulaciones y saltos de línea, por lo que el programador puede dar estilo al código de diferentes maneras sin afectar su significado. Generalmente, el programador utiliza un estilo que se considera que mejora la legibilidad .

Los dos fragmentos de código que aparecen a continuación son lógicamente iguales, pero difieren en los espacios en blanco.

int i ; for ( i = 0 ; i < 10 ; ++ i ){ printf ( "%d" , i * i + i ); }

versus

int i ; for ( i = 0 ; i < 10 ; ++ i ) { printf ( "%d" , i * i + i ); }

El uso de tabulaciones para los espacios en blanco es discutible. Los problemas de alineación surgen debido a las diferentes posiciones de tabulación en distintos entornos y al uso combinado de tabulaciones y espacios.

Por ejemplo, un programador prefiere usar cuatro tabulaciones y tiene su conjunto de herramientas configurado de esta manera, y las usa para dar formato a su código.

int ix ; // Índice para escanear el array long sum ; // Acumulador para sum

Otro programador prefiere usar tabulaciones de ocho, y su conjunto de herramientas está configurado de esta manera. Cuando alguien más examine el código de la persona original, es muy probable que le resulte difícil de leer.

int ix ; // Índice para escanear el array long sum ; // Acumulador para sum

Una solución común a este problema podría consistir en prohibir el uso de tabulaciones para la alineación o establecer reglas sobre cómo deben configurarse las tabulaciones. Cabe destacar que las tabulaciones funcionan correctamente siempre que se utilicen de forma coherente, se restrinjan a la indentación lógica y no se utilicen para la alineación.

clase MyClass { int foobar ( int qux , // primer parámetro int quux ); // segundo parámetro int foobar2 ( int qux , // primer parámetro int quux , // segundo parámetro int quuux ); // tercer parámetro };