Dovrei mettere newline prima o dopo gli operatori binari? [chiuso]

Quando sei in Python o Javascript, dovresti sempre mettere gli operatori binari alla fine della riga precedente, per evitare che le nuove righe terminino prematuramente il tuo codice; ti aiuta a rilevare gli errori.

Ma in C o C ++, questo non è un problema, quindi mi chiedo:

C'è qualche motivo per preferire la seconda versione alla prima?

return lots_of_text
       + 1;

contro

return lots_of_text +
       1;

(Ad esempio, uno di essi aiuta a prevenire altri tipi di errori? O uno di questi è considerato più leggibile?)

Come puoi vedere dalle risposte, non c'è consenso su questo argomento. A meno che tu non lavori in gruppo, usa ciò con cui ti senti più a tuo agio.

Io preferisco l'inserimento di una nuova riga prima di operatori.

Ogni volta che devo interrompere le linee, di solito metto al massimo un termine dello stesso "livello" su una linea:

La legge di gravitazione di Newton in Python:

force = (
    gravitational_constant
    * mass_1
    * mass_2
    / (distance * distance)
)

Confronta questo con:

force = (
    gravitational_constant *
    mass_1 *
    mass_2 /
    (distance * distance)
)

Voglio sapere che "divido per distanza al quadrato", non voglio sapere che "mass_2 viene diviso", perché non è così che penso alle espressioni matematiche.

_{Inoltre, di solito voglio sapere prima cosa sto facendo (operatore), prima di preoccuparmi di cosa faccio (operandi).}

Oppure considera questa istruzione SQL contorta:

WHERE
  a = 1
  AND b = 2
  AND c = 3
  AND ( -- or put the OR on one line together with the AND
    d = 3 
    OR e = 1)
  AND x = 5

Questo mi permette di vedere come le singole condizioni sono collegate molto facilmente, semplicemente scorrendo dall'alto verso il basso senza dover leggere tutte le righe fino alla fine per trovare l'operatore invece di:

WHERE
  a = 1 AND
  b = 2 AND
  c = 3 AND
  ( 
    d = 3 OR
    e = 1) AND
  x = 5

Penso al primo in termini di " Xè vero", quindi lo rettifico dicendo: " E questo è anche vero", che mi sembra più naturale del contrario. Inoltre, trovo il primo molto più facile da analizzare visivamente.

O un esempio di PHP:

$text = "lorem ipsum"
      . "dolor sit amet, "
      . "consectetur adipisicing elit, "
      . "sed do eiusmod tempor";

Ancora una volta, posso semplicemente sfogliare la lettura in verticale per vedere che sto semplicemente concatenando il testo, perché la maggior parte delle volte sento che in realtà non mi interessa cosa c'è dentro le stringhe / condizioni.

Naturalmente, non applicherei questo stile incondizionatamente. Se inserire la nuova riga dopo un operatore sembra avere più senso per me, lo farei, ma al momento non riesco a pensare ad un esempio.

Quasi sempre interrompo le righe davanti agli operatori binari per chiarire ai lettori del codice che questa è la continuazione di un'espressione e non la frase successiva. Ciò è importante se la frase successiva verrebbe normalmente rientrata. Ad esempio, considera un'istruzione if con un'espressione condizionale complessa:

if (first_part_of_condition &&
    second_part_of_condition) {
    statement_within_then_part;
}

La seconda parte dell'espressione condizionale viene facilmente confusa con la prima istruzione della parte in poi. Questo può essere abbastanza confuso se la prima parte della condizione è lunga e il && finisce a destra. Confronta questo con l'alternativa:

if (first_part_of_condition
    && second_part_of_condition) {
    statement_within_then_part;
}

Sembra un po 'strano ma rende abbastanza chiaro che la seconda parte della condizione non è l'inizio di un'istruzione.

Lo faccio anche in altri contesti, ma l'istruzione if è la più importante, poiché l'indentazione è ambigua. Naturalmente, si potrebbe cambiare il rientro o il posizionamento del controvento, ma anche questo sembra strano.

tl; dr l'estremità sinistra della riga è più significativa per una rapida comprensione della lettura, quindi mettere l'operatore all'estremità sinistra è un marcatore più evidente che questa è un'espressione continua, non un'affermazione.

Userei sempre il primo. Vuoi che sia chiaro cosa stai facendo con quell'1 lì. Se lo vedessi e ci fosse un muro di testo sopra quello 1 non avrei idea di cosa stesse succedendo fino all'utilizzo di quel 1.

Il '+' accanto a 1 chiarisce che almeno sto facendo qualcosa con l'1 in questione piuttosto che uscire in giro "Sono tutto nel tuo codice amico ..." senza una ragione apparente.

Sento che aiuta a leggere enormemente la comprensione quando una riga indica che l'istruzione continua nella riga successiva avendo l'operatore binario alla fine e rendendo così incompleta l'affermazione. Il punto e virgola mancante non mi basta per capirlo immediatamente.

Questa potrebbe essere semplicemente una questione di abitudine ma a meno che tu non lavori esclusivamente in lingue che richiedono il punto e virgola (che trovo piuttosto irrealistico data la pervasività di script shell, makefile e linguaggi come Python) probabilmente non avrai nemmeno quell'abitudine.

EDIT: Giorgio fa un eccellente punto nei commenti: questo uso fa eco alla punteggiatura comune , sia in matematica che in linguaggi naturali. Scriveresti

Affondo,
quindi ho nuotato

Si potrebbe non scrivere

Affondo
, quindi ho nuotato