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?