2013-01-16 121 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尚未开始,并且可以更自由地被另一个开发人员接受。 –