Esistono standard per separare diversi tipi di commenti (esplicativi, debug, cose da fare, ecc.)?

Question

Esistono standard per separare diversi tipi di commenti (esplicativi, debug, cose da fare, ecc.)?

#1 da (2 voti)

1

Per un po 'di tempo ho preso l'abitudine di differenziare diversi tipi di commenti nel mio codice.

//this is an explanatory comment

//!this line was commented out for debug purposes, DO NOT SHIP WITH THIS COMMENT IN PLACE

//?this code was tested, and executed properly in 2.3 uS

Questo mi ha risparmiato un sacco di problemi, in quanto posso rapidamente distinguere tra commenti di debug e commenti esplicativi. È particolarmente bello essere sicuri che tutti i miei commenti di debug siano andati, e nessuno è stato lasciato accidentalmente sul posto prima di pubblicare il mio codice.

Questa è una pratica comune? In tal caso, esiste un metodo standard per differenziare i commenti? O ci sono forse modi migliori per ottenere ciò che sto cercando di ottenere?

coding-standards comments

posta Stephen Collings 21.02.2014 - 22:05

fonte

1 risposta

Leggi altre domande sui tag coding-standards comments

Cose da considerare per invitare e limitare gli utenti a un sito Web beta Design e architettura del sito Web di aggiornamento

score 2 · Answer 1

Fondamentalmente non c'è bisogno di uno standard per tali commenti, perché di solito lo standard li rimuove prima del check-in.

Detto questo, il commento snarky di @ amon ha praticamente ragione. È possibile trarre molti vantaggi sfruttando il controllo del codice sorgente per rimuovere le modifiche di debug. Fondamentalmente, assicurati di solo apportare modifiche di debug dall'ultimo commit, quindi puoi annullarle tutte con un singolo comando. O esegui prima un diff se sei paranoico su ciò che verrà annullato.

Git è particolarmente facile da usare con questo modello perché i commit locali non devono essere condivisi e puoi facilmente creare un intero ramo solo per le modifiche temporanee del debug, o utilizzare la memorizzazione o l'indice. Tuttavia, lo faccio al lavoro con perforce, accantonando il mio lavoro in corso prima di apportare modifiche di debug, quindi annullando la cancellazione quando voglio che le modifiche al debug scompaiano. Penso che i più moderni sistemi di controllo delle versioni abbiano un concetto di scaffalatura.

L'altro vantaggio dell'utilizzo del controllo del codice sorgente per le modifiche di debug non è limitato alla ricerca di modifiche commentate. Le linee aggiunte, le linee parzialmente modificate e le linee riorganizzate vengono annullate con un solo comando. Devi solo apportare i cambiamenti necessari, senza preoccuparti di come li troverai in seguito per annullarli.