Quale formato di codice è stato verificato dagli studi di casi come più leggibili? [chiuso]

7

Esistono studi di casi di tracciamento oculare o ricerche simili effettuate per verificare quale formato di codice è più facile da leggere, gestire e utilizzare?

Ho sempre formattato il mio codice nel seguente modo:

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

Tuttavia, non ho mai visto questo seguito altrove. Nella maggior parte delle API o dei progetti open source, è fatto in questo modo.

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

Puoi fornire una risposta che non si basa sulle tue preferenze personali, ma è supportata da ricerche o da qualche tipo di fatto?

Sono stati effettuati studi di scansione oculare visiva per confermare quale formato è il migliore?

    
posta cgTag 07.05.2012 - 18:07
fonte

2 risposte

4

"Migliore" è relativo.

Purtroppo, non riesco a ricordare la fonte. Gli studi che ho visto o referenziati indicano che uno stile visivo coerente è la chiave per un progetto. Quale particolare casa di stile a cui venerate è meno importante della coerenza. Vedere l'articolo di Atwood per ulteriori riferimenti, in particolare per Code Complete: link

La premessa è che se stai eseguendo una revisione del codice, l'aggiornamento di un'area nuova / straniera o una ricerca di bug, la presentazione coerente consente allo sviluppatore di eseguire più rapidamente il tuo compito. Uno stile coerente riduce al minimo il tempo dedicato alla riqualificazione / adattamento durante lo spostamento nella struttura del codice.

Ecco un articolo di Joel Spolsky con alcuni riferimenti aggiuntivi e, a mio avviso, ricercati: link

O Atwood o Spolsky ti condurranno lungo il percorso verso Martin Fowler e Refactoring, dove ci sono più studi / riferimenti.

Questo sembra essere un articolo correlato alla tua domanda e alle "statistiche di leggibilità", ma dopo averlo sfiorato, non posso garantire pienamente la qualità della ricerca. Sembra che abbiano preso in prestito il concetto di leggibilità dalla scrittura regolare e abbiano cercato di applicarlo alla scrittura del codice. link

    
risposta data 07.05.2012 - 19:46
fonte
2

Qualunque formato il programmatore sia più abituato a leggere è il formato che leggerà più velocemente. Tuttavia, le differenze minori tra la formattazione contano poco rispetto alla chiarezza e concisione del codice e del design. In altre parole, non mi preoccuperei di newlines contro no-newlines e mi preoccuperei di codice terribile contro buono.

Ma per rispondere alla tua domanda preferisco il secondo metodo, in particolare quando // do something è una o due righe. Se sono blocchi grandi, puoi rifattarli in metodi con nomi chiari.

    
risposta data 07.05.2012 - 19:35
fonte

Leggi altre domande sui tag