Visual Studio中的标记：HACK，TODO...还有其他吗？

Question

Visual Studio中的标记：HACK，TODO...还有其他吗？

visual-studioconfigurationtoken

50

你在Visual Studio中使用哪些标记？(Visual Studio 2010 → 环境 → 任务列表 → 标记)

目前我只有以下几种：

HACK - 优先级较低
REVIEW - 优先级高
TODO - 普通优先级
WTF - 优先级高

(只使用这些，删除了默认的一些)

你还使用其他的吗？

你是否用注释标记来覆盖其他重要内容？

有什么最佳实践吗？谢谢！

- b0x0rz

可能应该设为社区维基。 - Konerak

8

如果您在寻找Visual Studio中的任务列表标记，请注意菜单命令为Visual Studio → 工具 → 选项 → 环境 → 任务列表 → 标记。 - lib

在Microsoft文档中，指出了以下内容：自定义标记默认情况下，Visual Studio包括以下标记： 1）HACK 2）TODO 3）UNDONE 4）UnresolvedMergeConflict。它们不区分大小写。您还可以创建自己的自定义标记。 - federico

哈哈，真好笑！ - steb

5个回答

27

以下是我使用的标记:

TODO: 功能尚未实现
FIXME: 代码应该被修改/重构以达到某些目标（例如更高的可维护性、更好的性能等）
BUG: 代码存在已知缺陷

- Enrico Campidoglio

我喜欢 FixMe 和 Bug :) 我使用 Hack 来修复 FixMe。将会添加 Bug！ - b0x0rz

2

我也是这样做的 :) -- 我会为我的 FIXME 添加子类别，例如：FIXME - 性能。 - cwap

好的。还有待办事项 - 翻译。我们使用Mantis#123来引用我们的缺陷跟踪系统和相应的编号。 - Konerak

9

我喜欢“REMOVE Token” (即移除令牌) 这个术语，它表明该令牌仅用于测试，并不应包含在最终版本中。

- KevinA

7

这是一种非常糟糕的做法。如果代码是用于测试，那么请使用预处理器指令的条件编译。 - AMissico

2

@AMissico 但是使用 // REMOVE 更容易。 - Gabriel

7

另一个内置的是NOTE。

- Tim Lloyd

5

是的，因为任何评论都可以算作一种注释，所以我不喜欢它。 - b0x0rz

同意，但我尽量不使用注释，除了用于备注的情况。如果有其他内容，我会将其记录在跟踪系统中，比如我的情况下是JIRA。 - Tim Lloyd

啊，我明白了，我会多多使用注释 :P - b0x0rz

我不太喜欢旧的绿色墨水 :) - Tim Lloyd

注意：这不仅会更改默认注释颜色，还可以在待办事项面板中为注释赋予配置文件。 - Chase Florell

请注意，当您想强制某人阅读您的注释时，这将非常有用。 - ElTête

5

Vim会自动高亮显示XXX，这恰好是我选择的标记，因为它很容易输入。根据Sun（旧版）Java编码规范，使用XXX来表示某些虚假但可行的东西，在注释中进行标记。使用FIXME来表示某些虚假且有问题的东西，在注释中进行标记。请参考此处了解更多信息。

- Mark Rushakoff

1

关于 Vim 的小技巧，不错。我之前不知道。 - b0x0rz

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Chase Florell · Accepted Answer

我已经结合使用了上面大多数标记。

 RED: code that simply does not work / compile
 // Error - This code is throwing a specific reproducible error.
 // Broken - This code is broken and will not run.
 // WTF - WHAT THE FRIG.

 ORANGE: code that works but is not right
 // Hack - This code has intentionally been hacked in order to work. Should not go into production.
 // FixMe - This code works but could be better. Needs better abstraction, maintainability, performance, etc.
 // Bug - This code works and was expected to be right but a bug has been found. (usually flagged post production)
 // Review - This code is probably right but should be reviewed for piece of mind.
 // Smells - Same as FixMe

 BLUE: code that works but either needs more features or more explaining
 // Todo - Functionality is not yet implemented
 // Note - Better explain what's going on. This is gives a higher profile to standard comments, and allows notes to be found in the to-do pane.