Commenti a riga singola per più righe di codice rientrate [chiuso]

Question

Commenti a riga singola per più righe di codice rientrate [chiuso]

#1 da (13 voti)
#2 da (7 voti)
#3 da (4 voti)
#4 da (2 voti)
#5 da (1 voti)
#6 da (1 voti)
#7 da (0 voti)

1

Dopo molti anni di codifica, tentativi di vari stili di programmazione, eliminazione di cose illeggibili o poco pratiche, non riesco ancora a capire una cosa: qual è il modo migliore per commentare a riga singola più righe di codice rientrato.

1.

    setup_checkpoint();
//    if (object->looks_suspicious())
//        guard->full_body_scan(object);

2.

    setup_checkpoint();
    // if (object->looks_suspicious())
    //     guard->full_body_scan(object);

3.

    setup_checkpoint();
    // if (object->looks_suspicious())
        // guard->full_body_scan(object);

Per favore, non suggerire commenti multilinea, perché a volte vuoi lasciare questa possibilità per blocchi più grandi, che possono includere piccoli pezzi di commenti.

coding-style code-formatting comments

posta mojuba 11.05.2011 - 16:41

fonte

7 risposte

Leggi altre domande sui tag coding-style code-formatting comments

Come si chiama una coda quando la coda della parola è riservata? [chiuso] "Opportunità" per assumere la manutenzione di un piccolo sito Web interno. Cosa dovrei fare?

score 13 · Answer 1

13

Dato che lo fai a scopo di test, di solito vuoi spiccare il più possibile, in modo da non trascurare la rimozione dei commenti o del codice in seguito. I marcatori di commento sul margine sinistro sono più visibili.

risposta data 11.05.2011 - 16:45

fonte

score 7 · Answer 2

Ecco come fa Visual Studio quando fai clic sul pulsante di selezione dei commenti:

    //private void Parse()
    //{
    //    while (_InputQueue.Count > 0)
    //    {
    //        switch (ParseState)
    //        {
    //            case AvailableStates.Begin:
    //            case AvailableStates.Found_ETX:
    //                byte FirstByte = _InputQueue.Dequeue();
    //                if (FirstByte == STX)
    //                {
    //                    ParseState = AvailableStates.Found_STX;
    //                }
    //                break;

Penso che funzioni bene e sia bello. Ovviamente l'evidenziazione della sintassi rappresenta probabilmente la metà della 'qualità'

score 4 · Answer 3

Qualunque cosa ti piaccia. Non dovresti lasciare cose del genere per più del tempo di risolvere qualche problema, giusto? Quindi sparirà in pochi minuti.

Se invece usi effettivamente un codice del genere per periodi più lunghi, si tratta di un problema diverso. Rimuovi i blocchi che non ti servono e utilizza il controllo della versione per assicurarti di trovarli di nuovo nel caso in cui ne avessi bisogno in un mese.

score 2 · Answer 4

Quando commento il codice, inserisco sempre il commento prima di ogni indentazione poiché, come dice @David Thornley, si distingue meglio quando si sfoglia il codice. Inoltre, poiché utilizzo vim, è facile inserire / eliminare i commenti in modalità blocco visivo senza creare alcun rientro.

score 1 · Answer 5

Non esiste un obiettivo "migliore": ogni stile è valido e potrebbero esserci preferenze personali per ciascuno di questi tre stili.

Personalmente, uso sempre il primo stile (avendo // a partire dalla prima colonna) poiché sono le impostazioni predefinite per la maggior parte degli IDE che conosco e sembra semplicemente buono.

score 1 · Answer 6

Per come la vedo io, l'importanza della formattazione del codice sorgente è navigazione sicura e veloce . Ecco perché i commenti sulla linea dovrebbero essere saltati in modo sicuro, naturalmente senza leggendoli.

Come distinguere commenti ( // ) e documentazione ( /// ) dai cosiddetti "blocchi commentati" nel codice sorgente impegnato, ho deciso di utilizzare due stili di commento a riga speciale . Questo è stato diversi anni fa e non me ne pento.

1) //<< un blocco che fa parte di una "transazione" eliminazione :

//<< /// what something does...
//<< void something_obsolet()
//<< {
//<<     some_stuff();
//<< }

2) //<? segna una cancellazione di cui sono attualmente in fase di controllo nell'IDE:

if (condition) {
    do_something();
//<? } else {
//<?             do_something_else();
}

Naturalmente, uso il controllo della versione per gestire le varianti. Ma (1) quando si eliminano diverse parti corrispondenti, cambio tra la compilazione e la ricerca per eliminare tutti i suoi resti. Ogni volta che trovo commenti di questo stile nel codice commit, lo cancello senza nemmeno pensarci. Anche se in casi molto rari, utilizzo uno stile di commento speciale (2) per testare particolari cancellazioni all'interno di un IDE, perché non posso prevedere il prossimo squillo del telefono, questo è il mio stile più breve.

Quindi la domanda sul rientro diventa secondaria, ma come ho osservato, mettendo i segni di commento all'estrema sinistra, proprio all'inizio della riga, sembra funzionare meglio ...

score 0 · Answer 7

0

Eclipse lo fa nel modo in cui l'hai mostrato nell'esempio 1 e personalmente trovo questo modo molto più leggibile degli altri.

risposta data 11.05.2011 - 16:44

fonte