なぜみんながto-doコメントを大文字で書くのですか?[閉まっている]


9

私も同じことをしています。コードに「やること」があるときは、と書き//TODO ...ます。しかし、これがいつ始まったのか、すべての大文字で「to-do」を書く理由があるのか​​どうか知りたいのですが。


20
私たちは本当に意味のあるものだからです(実際にそれを回避することはありません)
Anthony Pegram

3
編集者はそれらにマークを付け、それらを検索できるようにします(たとえば、Eclipseのタスクリスト)
ラチェットフリーク

6
コード内でテキストを実際に太字にすることができなかったので、重要なものを目立たせるための何らかの方法が必要でした。したがって...
Karlson、2011

4
なぜそれが重要なのですか?
2011

3
I書き込み//todo:...
BЈовић

回答:


23

また、つぶれたコードセクションを簡単に検索して、元に戻したい方法があると便利です。「TODO」を大文字と小文字を区別して検索すると、前にスキップしたものをすぐに見つけることができます。

"todo"(小文字)は大きな単語/関数/変数の一部である可能性がありますが、 "TODO"(大文字)はおそらく含まれません。


4
また、編集者がこれを強調することもできます。たとえば、geditはそれを実行し、すべて大文字の場合にのみ実行しTODOます。理由が何であれ、大文字で書くのは十分な動機付けです。

4
@delnan:それはトートロジーです。それは目立つように行われたので、人々はそれを使ったので、誰かがvimで構文強調表示を追加してもっと目立たせたので、人々はそれを使って目立つようにしました。エディターはそれを目立たせるので、人々はそれを使用しません。構文ハイライトを適切に変更するだけでvimで何かを目立たせることができます。目立つようにするのも簡単todoですが、慣例としてTODOを使用することはほとんど意味がありません。
マーティンヨーク

1
@LokiAstari:として私は言った、より多くの編集者は、デフォルトではそのを強調するので1は首都でそれを綴るため。しかし、おそらく私は例外です:かなり若い(編集者がサポートする前にそれを行うことができなかった)と(悲しいことに)構文の強調表示を手動で調整するにはあまりにも多くの気まぐれで面倒です。

また、あなたの後を片付ける必要がある貧しい人のために、そしてそれが完了する前にあなたのコードを見直す必要がある人のためにもいいです。彼らはこの慣習のためにまだ何が行われていないかを一目で見ることができます。
sq33G 2011

2
のような変数名内で大文字と小文字が混在するTODOに遭遇しましたfilesToDownload。もちろん、「全単語のみ」の検索はその問題を修正します。
dan04

8

私はこれがいつ始まったのか、そしてto-dos all capitalを書く理由があるかどうか知りたいと思っています。

TODOやFIXMEなどのコメント付きのアイデアは、それらを目立たせることです。通常、そのようなマーカーがコードに含まれているコードを出荷することは望ましくありません。これらは、プロジェクトが完了したと見なされる前に実行する必要があることを示します。ALL CAPSを使用すると、コード内の他の多くのことにもALL CAPSを使用しない限り、それらを見つけやすくなります。


5

EclipseとVisual Studioのどちらにも、TODOが含まれているコメント行のリストを自動的に表示するタスクリスト機能があります。


Visual Studioは、MFCボイラープレート関連のコードジェネレーターを最初に追加したときに// TODO:コメントを開始しました。それはバージョン2.0、iircでした。
mjfgates 2011

少なくともVisual Studioの場合、この検索で​​は大文字と小文字が区別されません。これにより、// todo fooもタスクリストに追加されます
jk。


1

todo が存在することに注意を喚起します。

誰かがコードに戻る必要があることは常に明らかであることが重要です。詳細は、問題が何であれ、対処するために戻ってくる人が知っている必要があります。


1

あなたがviユーザーの場合:

/ TODO

それはあなたをそこに非常に速く連れて行きます。


他のエディターには検索機能があり、todoと同じくらい簡単に検索できます。
Karlson、2011

'todo'が変数名や他のコメントテキストなどの他の場所に表示される場合を除いて...
sevenseacat

1
viは大文字と小文字を区別します。現代のほとんどの言語(名前付き定数など)では大文字の使用は控えめなので、検索が成功する可能性は高くなります。
ncmathsadist

1

一部のエディターは大文字のTODO項目のみを強調表示するため、常に大文字を使用する方が安全です。


0

視覚的にすべての大文字が目立ちますが、あまり判読できません。コードを読み取るとき、特定のサイズのブロックとしてスキャンします。文字が何であるかは問題ではありません。彼らは目立つだけで、すぐに見ることができます。しばらくタグを操作すると、脳は単語を形で認識します。

ツール(IDE /エディタ)の観点から見ると、大文字と小文字を区別する検索では、すべての大文字バージョンで誤検出率が非常に低くなります。一部のコーディングスタイルでは、定数が一致するという小さなリスクがあります。大文字と小文字を区別する全単語検索により、誤検知の可能性がさらに低くなります。

ツールが画面上でそれを取得すると、フォーマットは「ここを見てください」と明確に表示されます。場所に集中すると、読みやすい部分が関連コメントになります。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.