为什么每个人都用大写字母写待办事项?[关闭]


9

我也一样 当我的代码中有要做的事情时,我写//TODO ...。但是我很好奇,这是什么时候开始的,是否有理由在所有大写字母中写“待办事项”?


20
因为我们真的很认真(我们从来没有真正解决过它)
Anthony Pegram

3
因此编辑者可以标记它们并让您搜索它们(例如,蚀的任务列表)
棘手怪胎

6
由于您实际上无法在代码中使文本变为粗体,因此需要某种方式使重要的事情脱颖而出。因此...
Karlson

4
为什么这有关系?
鲁克

3
我写//todo:...
BЈовић

Answers:


23

同样,很高兴有一种方法可以轻松地搜索您蒙蔽并希望返回的代码段。您可以对“ TODO”进行区分大小写的搜索,以立即找到之前跳过的内容。

“ todo”(小写)可能是较大的单词/函数/变量的一部分,但“ TODO”(大写)可能不会出现。


4
它还允许编辑器突出显示此内容。例如,gedit会执行此操作,并且仅对所有大写字母执行此操作TODO。不管是什么原因,这足以激励我写大写字母。

4
@delnan:这是一个重言式。这样做是为了突出,所以人们使用了它,因此有人在vim中添加了语法突出显示以突出​​显示更多内容,因此人们使用它来突出显示。人们之所以不使用它,是因为编辑器使它脱颖而出,而因为这样做是很常见的,因此编辑器使它脱颖而出。您可以在vim中使任何内容脱颖而出,只需适当地更改语法突出显示即可使它todo脱颖而出,但是由于约定是使用TODO,因此没有什么意义。
马丁·约克

1
@LokiAstari:就像我说的,用大写字母拼写一个是因为默认情况下有更多的编辑器突出显示它。但也许我是一个例外:很年轻(所以我不能做它的编辑支持前)和(可惜)太whimp和懒惰的混混的调整语法高亮手动。

对于需要在您之后进行清理的可怜人,以及需要在代码完成之前进行检查的任何人来说,这也非常好。他们可以一目了然地看到由于该约定尚未执行的操作。
sq33G 2011年

2
我在像这样的变量名称中遇到了大小写混合的TODO filesToDownload。当然,“仅全词”搜索可解决该问题。
dan04 2012年

8

我很想知道何时开始以及是否有理由写待办事项?

带有注释(如TODO和FIXME)的想法是使它们突出。通常,您不希望交付在代码中包含此类标记的代码-它们标记了可以视为项目完成之前要做的事情。使用ALL CAPS使它们更容易发现,前提是您也不要将ALL CAPS用于代码中的许多其他事情。


5

Eclipse和Visual Studio都具有“任务列表”功能,这些功能会自动为您提供其中包含TODO的注释行列表。


当Visual Studio首次为MFC样板文件添加代码生成器时,便开始执行// TODO:注释。那是iirc版本2.0。
mjfgates 2011年

至少对于Visual Studio而言,此搜索不区分大小写-它将// todo foo也拉进任务列表
jk。

4

我只是脱颖而出,很容易抓住……没有什么复杂的!


1
这一点,它很容易通过的grep或类似的发现
扎卡里ķ

@ZacharyK:是的!
2012年

1

它提请注意存在的事实待办事项。

很重要的一点是,始终需要有人返回代码。回来的人只需要知道细节即可解决任何问题。


1

如果您是vi用户,请使用:

/去做

它将很快带您到那里。


其他编辑器具有搜索功能,您可以轻松地搜索待办事项
卡森

除了'todo'可能会出现在变量名或其他注释文本之类的地方外……
sevenseacat 2011年

1
vi区分大小写。由于大多数现代语言(例如命名常量等)很少使用大写,因此搜索成功的可能性很高。
ncmathsadist 2011年


0

在外观上,所有大写字母都很突出,但不是很清晰。读取代码时,它们将扫描为特定大小的块。字母到底是什么并不重要。他们只是脱颖而出,可以很快看到。使用标签一段时间后,您的大脑将按形状识别单词。

从工具(IDE /编辑器)的角度来看,区分大小写的搜索在所有大写版本上的误报率都非常低。在某些编码样式中,常量匹配的风险很小。区分大小写的全字搜索使误报率更低。

工具在屏幕上显示后,格式就会清楚显示在这里。一旦您专注于位置,清晰的部分将是相关注释。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.