Verwendung von HACK- und UNDE-Kommentartags

Question

Viele Softwareingenieure sind mit der Verwendung von speziellen Kommentartags, die ihren Codekommentaren hinzugefügt werden können, zur Verwendung bei Suchvorgängen, automatisierter Aufgabenverfolgung usw. vertraut. Einige der beliebtesten sind FIXME, TODO, UNDONE und HACK.

Ich bin ein bisschen verwirrt mit der Verwendung von HACK und UNDONE Tags. Kleine Hilfe bitte?

Bonuspunkte für die Ansicht den grundlegenden Unterschied zwischen FIXME und To-do

Answer 1

Mein Verständnis:

• ERLEDIGEN: Etwas, das getan werden muss. Dies könnte eine Funktion sein, die später hinzugefügt wird, oder anzeigt, dass etwas ein Stub ist und implementiert werden muss.

• FIXME: Eine Unterklasse der TODO-Tag, etwas anzeigt, ist gebrochen, die fixiert sein muss.

• UNDONE: Eine Notiz, die auf eine Änderung hinweist, die ein Rollback oder eine Umkehrung einer anderen Änderung war. Dieser Kommentar zeigt normalerweise an, was entfernt wurde und warum.

• HACK: Etwas, normalerweise ein merkwürdiges oder unorthadoxes Stück Code, das hinzugefügt wurde, um ein bestimmtes Problem zu beheben. Dies sind in der Regel keine "eleganten" Lösungen, aber nichtsdestotrotz macht das verdammte Ding funktioniert. Oft werden Sie diese sehen, um einen Fehler im Framework oder ein anderes unerwartetes Verhalten zu beheben. Zusätzlich wird der Zweck des kommentierten Codes oft unklar sein, wäre da nicht der Kommentar.

Answer 2

UNDONE mir bedeutet, dass das Verfahren nicht abgeschlossen ist, gibt sie in der Regel den Datentyp, obwohl keine internen Code

ich wollte, das sagen, weil einige Leute es eine Umkehrung betrachten, würde ich nicht verschmutzen die Code mit dieser Art von Kommentaren und haben das Gefühl, dass viele andere Menschen UNDONE verwenden könnten das gleiche bedeuten wie ich

es ist eine liberale ruleset aber es ist ein großartiges System

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

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