我喜欢TODO评论。还有FIXME评论。好吧，我喜欢任何有助于我完成任务的非代码文本。
我知道有些人认为它们会臭，您绝对不能使用它们，或者至少要犯下它们。
我在大学里遇到了许多老师，他们总是告诉学生。我认为这是可怕的建议。

据我所知，针对TODO评论有两个主要动机。

• 首先，您应该在错误或问题跟踪器中跟踪这些内容。
• 第二，如果您与多个用户合作，并且每个人都使用TODO评论，他们会失去所有意义，因为您无法跟踪您的内容，什么不是您的内容。

第一个回答更加棘手，我可以理解这种情感，但是只有一些事情值得花时间，有些项目的行为也有所不同。
通常，FIXME或TODO通常比真实问题或错误小。应在适当的工具中跟踪真正的问题，至少可以在开发人员之间进行对话。如果这是“我需要稍后检查”之类的小东西，请使用TODO评论。除此之外，如果您正在处理拉动请求，它们还可以。如果它们没有有意义的话，您可以稍后将它们删除。

第二个是正确的。但是不使用评论不是解决方案。解决方案是使它们正确！我将告诉您过去几个月中我在工作流程中添加的最简单和最愚蠢的事情（我想我已经这样做了一年了）。

而不是这样做：

func hello() {
    // TODO I need to change the text later
    fmt.Println("Hello world!")
}

在我的情况下，尝试在控制版系统中使用用户名：

func hello() {
    // TODO(alexsaezm) I need to change the text later
    fmt.Println("Hello world!")
}

然后，这是技巧。 许多IDE和编辑器允许根据正则表达式过滤评论！

就我而言，我如今主要使用Goland，但它在所有喷气桥产品中都起作用。

转到“ TODO”选项卡，单击过滤器图标，然后选择编辑过滤器：

然后，添加类似的东西：

享受您的有用评论！