Correggere l'allineamento durante il codice in uscita

6

Supponiamo di avere del codice

void some_block(void)
{
    some_statement_1();
    some_statement_2();
    some_statement_3();
}

Ora desidero commentare l'affermazione n. 2, ma qui non riesco mai a trovare un modo in cui sia giusto. Di solito farò quanto segue:

void some_block(void)
{
    some_statement_1();
//    some_statement_2();
    some_statement_3();
}

Ma ora abbiamo quello che sembra un ulteriore indentazione dell'affermazione n. 2, tuttavia è discutibile se il rientro sia ancora "corretto". In alternativa potremmo fare:

void some_block(void)
{
    some_statement_1();
    //some_statement_2();
    some_statement_3();
}

Questo sembra un po 'meglio, ma ancora in qualche modo anche sbagliato. Tuttavia, il seguente aspetto sembra errato:

void some_block(void)
{
    some_statement_1();
  //some_statement_2();
    some_statement_3();
}

Come fai il codice del risultato e mantieni la rientranza "corretta"?

Aggiorna

Sembra che la maggior parte delle persone che hanno fornito risposte non abbia risposto alla mia domanda, ma dichiara semplicemente che è una cattiva pratica lasciare in giro il codice morto. Mentre sono completamente d'accordo, non era questo il punto della domanda.

In questo momento sto affrontando un caso di esempio in cui ho 5 funzioni di supporto, che gestiscono 5 strutture simili ma leggermente diverse per me. Uso queste funzioni di supporto per semplificare la lettura del codice.

Ma, al momento (e probabilmente per il prossimo mese) probabilmente una delle strutture non verrà utilizzata. E non posso commettere nulla che provochi gli avvertimenti del compilatore, quindi devo superare questa parte del codice e commetterlo in questo modo.

Inoltre ho dimenticato quest'ultima variante, che a mio parere sembra semplicemente sbagliata:

void some_block(void)
{
    some_statement_1();
//  some_statement_2();
    some_statement_3();
}
    
posta Bjarke Freund-Hansen 01.12.2010 - 14:08
fonte

4 risposte

24

Formattalo in modo che rimanga visibile e rendi il tuo codice così brutto da essere costretto a eliminarlo. I commenti sono per commenti e non per trattare codice non necessario; questo è il lavoro del controllo della versione.

    
risposta data 01.12.2010 - 14:16
fonte
15

Che mi dici di questo?

void some_block(void)
{
    some_statement_1();
    some_statement_3();
}
    
risposta data 01.12.2010 - 14:32
fonte
4

Premo Ctrl- / e qualunque sia il mio IDE, lo faccio. L'evidenziazione dei colori mi dice di ignorare comunque quella linea (o di prestare attenzione, a seconda del mio contesto).

Prima di allora, ho usato per sostituire gli spazi con le barre, mantenendo l'allineamento:

block {
    codeline1;
//  codeline2;
    codeline3;
}

Ovviamente, è sufficiente inserire le barre per il codice flush-left.

    
risposta data 01.12.2010 - 14:46
fonte
2

Come ho detto Alex in the emacs, utilizzo la regione dei commenti e lascia che sia gestito da emacs. (Si prega di non votare per utente di vi per l'utilizzo di emacs. :-)). Una volta che sono sicuro del mio codice, lo cancellerò. Il punto è lasciare il tuo editor preferito e abituarsi a ciò che l'editor fa.

    
risposta data 01.12.2010 - 15:26
fonte

Leggi altre domande sui tag