使用HACK和UNDONE注释标记

时间:2013-01-16 19:26:04

标签: language-agnostic coding-style documentation tags

许多软件工程师熟悉可以添加到代码注释中的特殊注释“标签”的使用,以用于搜索,自动化任务跟踪等。一些最流行的是FIXME,TODO,UNDONE和HACK。

我对HACK和UNDONE标签的使用有点困惑。请帮忙吗?

显示FIXME和TODO之间基本区别的加分点

2 个答案:

答案 0 :(得分:16)

我的理解:

  • TODO:需要做的事情。这可能是稍后要添加的功能,或者表明某些内容是存根并且需要实现。

  • FIXME:TODO标记的子类,表示某些已损坏需要修复

  • UNDONE:表示某项更改的注释,该更改是某些其他更改的回滚或撤消。此评论通常会指出删除的内容和原因。

  • HACK:一些东西,通常是一段奇怪的或非繁琐的代码,它被添加来修复某些特定的问题。这些通常不是“优雅”的解决方案,但仍然可以使这个有用的东西起作用。通常,您会看到这些来解决框架中的错误或其他意外行为。此外,如果不是评论,评论代码的目的通常不明确。

答案 1 :(得分:-1)

对我来说意味着该方法没有完成,它通常会返回数据类型,尽管没有内部代码

我想说这是因为有些人认为这是一种逆转,我不会用这些评论来污染代码,并且有一种感觉,许多其他人可能会使用UNDONE来表示和我一样

它是一个自由的规则集,但它是一个伟大的系统

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

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