Come discriminare commenti di codice e documentazione commentati

Non contrassegnare i commenti come commenti, se trovi il codice commentato mentre lavori in un file, semplicemente cancellalo. Prova anche a convincere quelli che ancora insistono nel commentare il codice per non farlo, non cambierà nulla a meno che tu non possa impedire alle persone di commentare blocchi di codice errato e non solo di eliminarli. Quindi è solo una questione semplice del tuo team che lavora insieme per eliminare il codice commentato quando lo trova, cercando di far tornare quelli che hanno lasciato il codice commentato e pulirlo è solo una ricetta per il dramma non necessario.

Fai attenzione, perché a volte i commenti alla documentazione contengono anche esempi di codice. Vuoi mantenere quelli. Ad esempio:

/**
  * This class does something.
  * Usage:
  * <code>
  * MyClass.doSomething();
  * </code>
  */

Probabilmente non esiste un metodo a prova di errore, ma potresti scrivere un breve script Perl che trova tutti i commenti nel codice, mantiene i commenti della documentazione e poi fa un'ipotesi sui rimanenti usando alcune espressioni regolari per l'inizio del commento.

Penso che la strategia "nuke on sight" suggerita da @Ryathal sia corretta.

Se vuoi rilevare il codice commentato (per favore non chiamarlo "codice commentato" perché molte persone pensano che significhi codice con commenti!) quindi penso che avrai bisogno di farlo esaminando le differenze tra versioni successive. Anche in questo caso non è semplice perché esiste una varietà di modi per commentare il codice ... a seconda del linguaggio di programmazione.

Se desideri una soluzione automatizzata, puoi analizzare i commenti per vedere se sono codice valido. In generale questo identificerebbe il codice commentato. Il codice di esempio è una cosa che devi fare attenzione a eliminare accidentalmente. Sebbene tu possa controllare se c'è un modo un po 'standard di formattarli che potresti usare per identificarli o ignorarli. Per esempio. si trovano in un blocco di commenti di intestazione o funzione o contrassegnati in altro modo.