TODO indica "task da completare", FIXME da correggere ecc. Esiste un tag di codice che indica "necessità di miglioramento" sui commenti di codice?
La cosa più vicina a un documento che cerca di standardizzare questo è il PEP 350 di Python - che era rifiutato come non uno standard.
La sezione Mnemonics ha una lista di vari usati - esita a chiamare qualcuno di "comunemente usato" oltre a "TODO", "FIXME" e "XXX" (che sono predefiniti in eclissi).
Oltre a ciò, è la convenzione locale di quel codebase e del team.
La nuova domanda: esiste un tag di codice del tipo "necessario miglioramento". La best practice dovrebbe utilizzare il set minimo di tag. "TODO" indica un'attività nel codice. // TODO this code needs to be refactored
sarebbe sufficiente piuttosto che utilizzare un altro // RFE should refactor
o // IDEA you know, we should refactor this
. TODO
è già riconosciuto da Eclipse, per convenzione, da mylyn .
Leggi altre domande sui tag comments