Utilizzo di tag di commento HACK e UNDONE

Question

Molti ingegneri del software hanno familiarità con l'utilizzo di "tag" di commento speciali che possono essere aggiunti ai commenti del codice, per l'utilizzo nelle ricerche, il tracciamento automatico delle attività e così via. Alcuni dei più popolari sono FIXME, TODO, UNDONE e HACK.

Sono un po 'confuso con l'utilizzo dei tag HACK e UNDONE. Piccolo aiuto per favore?

punti bonus per mostrare la differenza fondamentale tra FIXME e TODO

Answer 1

mia comprensione:

• TODO: Qualcosa che deve essere fatto. Questa potrebbe essere una funzionalità da aggiungere in seguito o indicare che qualcosa è uno stub e deve essere implementato.

• FIXME: Una sottoclasse del tag TODO, indica qualcosa è rotto che ha bisogno di essere fisso.

• UNDONE: una nota per indicare una modifica che era un rollback o un'inversione di qualche altra modifica. Questo commento indicherà solitamente cosa è stato rimosso e perché.

• HACK: Qualcosa, di solito un pezzo di codice strano o unortodosso, che è stato aggiunto per risolvere qualche problema particolare. Queste di solito non sono soluzioni "eleganti", ma comunque fanno funzionare la cosa maledettamente. Spesso li vedrai per risolvere un bug nel framework o altri comportamenti imprevisti. Inoltre, lo scopo del codice commentato spesso non è chiaro se non fosse per il commento.

Answer 2

UNDONE per me significa che il metodo non è finito, di solito restituisce il tipo di dati, nonostante nessun codice interno

volevo dire questo perché alcune persone lo considerano un rovesciamento, non avrei inquinare il codice con questi tipi di commenti e di avere la sensazione che molte altre persone potrebbero utilizzare UNDONE per significare lo stesso come me

si tratta di un set di regole liberale, ma si tratta di un grande sistema

public int SomeCalculation(int Input) 
{ 
    return 0; //UNDONE 
} 

public bool SomeCheck() 
{ 
    return false; //UNDONE 
}