2013-01-16 11 views
10

Wielu programistów jest zaznajomionych z użyciem specjalnych "znaczników" komentarzy, które można dodać do swoich komentarzy do kodu, do wykorzystania w wyszukiwaniu, zautomatyzowanym śledzeniu zadań i tak dalej. Niektóre z najpopularniejszych to FIXME, TODO, UNDONE i HACK.Używanie znaczników komentarza HACK and UNDONE

Jestem nieco zdezorientowany z użyciem tagów HACK i UNDONE. Mała pomoc, proszę?

punkty za ukazujący podstawową różnicę między FIXME i zadania

+6

Pers Onally moim ulubionym jest NICINGTEEEEHERE. –

Odpowiedz

14

Moje rozumienie:

  • TODO: Coś, co należy zrobić. Może to być funkcja dodawana później lub wskazująca, że ​​coś jest skrótem i musi zostać zaimplementowane.

  • FIXME: Podklasa tagu TODO, wskazując coś jest uszkodzony który musi być stałe.

  • UNDONE: Notatka informująca o zmianie, która była wycofaniem lub odwróceniem jakiejś innej zmiany. Ten komentarz zazwyczaj wskazuje, co zostało usunięte i dlaczego.

  • HACK: Coś, zwykle dziwny lub nietypowy fragment kodu, który został dodany w celu rozwiązania konkretnego problemu. Zwykle nie są to "eleganckie" rozwiązania, ale mimo wszystko sprawiają, że rzeczy te działają. Często widzisz, że rozwiązują one problem w ramie lub inne nieoczekiwane zachowanie. Dodatkowo, cel skomentowanego kodu będzie często niejasny, gdy nie będzie on komentowany.

-1

cofnąć do mnie oznacza, że ​​metoda nie jest zakończona, to zwykle zwraca typ danych, pomimo braku kodu wewnętrznego

Chciałem powiedzieć o tym, ponieważ niektórzy ludzie uważają, że odwrócenie, nie zanieczyszczają Kod z tego rodzaju komentarze i mam wrażenie, że wiele innych osób może korzystać cofnąć oznaczać takie same jak ja

to liberalny zestaw reguł, ale to wspaniały system

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

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

To jest kolejna interpretacja czasownika, ale dlaczego nie wystarczy użyć TODO. Wtedy nie ma dwuznaczności. –

+0

Różnica pomiędzy UNDONE i TODO polega na tym, że UNDONE jest bardziej podobna do pracy w toku i nie powinna być dotykana przez innego dewelopera, a TODO jeszcze się nie rozpoczęło i jest wolniejsze, aby inny twórca go pobrał. –