language-agnostic - HACK 和 UNDONE 注释标签的使用

Question

许多软件工程师都熟悉特殊注释“标签”的使用，这些注释“标签”可以添加到他们的代码注释中，用于搜索、自动任务跟踪等。其中一些最受欢迎的是 FIXME、TODO、UNDONE 和 HACK。

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

显示 FIXME 和 TODO 之间基本区别的奖励积分

score 30 · Accepted Answer

我的理解：

TODO：需要做的事情。这可能是稍后添加的功能，或者表明某些东西是存根并且需要实现。
FIXME：TODO 标记的子类，表示有问题需要修复。
UNDONE：指示更改是回滚或撤消其他更改的注释。此评论通常会指出删除的内容和原因。
HACK：一些东西，通常是一段奇怪的或非正统的代码，被添加来解决一些特定的问题。这些通常不是“优雅”的解决方案，但仍然可以使该死的事情发挥作用。通常，您会看到这些以解决框架中的错误或其他意外行为。此外，如果不是为了注释，注释代码的目的通常会不清楚。

score 0 · Accepted Answer

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

我想说这个是因为有些人认为这是一种颠倒，我不会用这些评论污染代码，并且感觉很多其他人可能会使用 UNDONE 来表示和我一样的意思

这是一个自由的规则集，但它是一个很棒的系统

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

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

2 回答 2