¿Qué formato de código ha sido verificado por los estudios de caso como el más legible? [cerrado]

7

¿Se han realizado estudios de casos de seguimiento ocular o investigaciones similares para verificar qué formato de código es más fácil de leer, mantener y trabajar?

Siempre formulo mi código de la siguiente manera:

function thing()
{
    if(something)
    {
      // do something
    }
    else
    {
      // do something else
    }
}

Sin embargo, nunca veo esto seguido en otros lugares. En la mayoría de las API o proyectos de código abierto, se hace así.

function thing() {
    if(something) {
      // do something
    } else {
      // do something else
    }
}

¿Puede proporcionar una respuesta que no se base en su preferencia personal, sino que esté respaldada por una investigación o algún tipo de hecho?

¿Se han realizado estudios visuales de exploración ocular para confirmar cuál es el mejor formato?

    
pregunta cgTag 07.05.2012 - 18:07

2 respuestas

4

"Mejor" es relativo.

Lamentablemente, no puedo recordar la fuente. Los estudios que he visto o que fueron referenciados indican que un estilo visual consistente es la clave para un proyecto. La casa particular de estilo a la que adoras es menos importante que la consistencia. Consulte el artículo de Atwood para obtener referencias adicionales, especialmente sobre Code Complete: enlace

La premisa es que si está realizando una revisión de código, actualizando un área nueva / extranjera o buscando errores, la presentación consistente le permite a usted, el desarrollador, realizar su tarea más rápidamente. Un estilo coherente minimiza el tiempo empleado en volver a entrenar / adaptarse mientras se mueve en el árbol de códigos.

Aquí hay un artículo de Joel Spolsky con algunas referencias adicionales, y creo que investigadas: enlace

Atwood o Spolsky lo llevarán por el camino hacia Martin Fowler y Refactoring, donde hay más estudios / referencias.

Este parece ser un artículo relacionado con su pregunta y sus "estadísticas de legibilidad", pero después de examinarlo, no puedo responder por la calidad de la investigación. Parece que tomaron prestado el concepto de legibilidad de la escritura regular y trataron de aplicarlo a la escritura del código. enlace

    
respondido por el GlenH7 07.05.2012 - 19:46
2

Cualquier formato que un programador esté más acostumbrado a leer es el formato en el que leerán más rápido. Sin embargo, las pequeñas diferencias entre el formateo no importan en comparación con lo claro y conciso que es el código y el diseño. En otras palabras, no me preocuparía por las nuevas líneas vs no-newlines y me preocuparía por el código terrible vs bueno.

Pero para responder a su pregunta, prefiero el segundo método, especialmente cuando el // do something es una o dos líneas. Si son bloques grandes, puede refactorizarlos en métodos con nombres claros.

    
respondido por el Garrett Hall 07.05.2012 - 19:35

Lea otras preguntas en las etiquetas