2013-01-16 150 views
10

許多軟件工程師都熟悉特殊註釋「標籤」的使用,這些標籤可以添加到他們的代碼註釋中,用於搜索,自動化任務跟蹤等等。一些最受歡迎的是FIXME,TODO,UNDONE和HACK。HACK和UNDONE評論標籤的使用

我對HACK和UNDONE標籤的使用有點困惑。請幫忙嗎?用於顯示FIXME和TODO之間的基本區別

獎勵積分

+6

Pers的我最喜歡的是NOTHINGTOSEEHERE。 –

回答

14

我的理解:

  • TODO:東西需要做。這可能是稍後添加的功能,或者表明某些內容是存根並需要實施。

  • FIXME:所述TODO標籤的一個子類,指示某物是破碎需要被固定

  • UNDONE:一個註釋,指出一個變化是一個其他變化的倒退或逆轉。此評論通常會指出已刪除的內容以及原因。

  • HACK:一些東西,通常是一段奇怪的或不碎片的代碼,它被添加來解決一些特定的問題。這些通常不是「優雅」的解決方案,但仍然可以幫助解決問題。通常你會看到這些來解決框架中的錯誤或其他意外行爲。此外,評論代碼的目的往往不清楚,如果不是評論。

-1

UNDONE對我來說意味着該方法還沒有完成,它通常儘管沒有內部代碼

我想這樣說是因爲有些人認爲這是一個反轉返回的數據類型,我不會污染這些各種各樣的意見代碼和有一種感覺,很多人可能會使用UNDONE意味着我一樣

這是一個自由的規則集,但它是一個偉大的系統

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

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

這是動詞的另一種解釋,但爲什麼不直接使用TODO。那麼就沒有歧義。 –

+0

UNDONE和TODO之間的區別在於,UNDONE更像是正在進行的工作,不應該被另一個開發人員觸及,而TODO尚未開始,並且可以更自由地被另一個開發人員接受。 –