web-dev-qa-db-ja.com

コメントでXXXはどういう意味ですか？

コメントにXXXが表示されている場合、一般的にどういう意味ですか。時々、次のようなコメントが表示されます。

# XXX - This widget really should frobulate the whatsit

もちろん、コメントの意味はわかりますが、XXXは一般的にどういう意味ですか？ 「これはハックだ」と言っているのでしょうか、それとも「おそらくこれを後で再検討する必要があるのでしょう」でしょうか。それとも完全に別のことを言っているのですか？

commentscoding-standards
72
Jason Baker

XXXが何を表すかは、コードの作成者によって異なります。一般的に、注意が必要なコードのマーカーとして使用されます。

ただし、 このWebページ は、やや異なる一連の考え方を示しています。

XXX：偽物だが機能するものにフラグを付けるために使用

FIXME：偽物で壊れているものにフラグを付けるために使用されます

これはさらに、その意味が明確に定義されておらず、使用方法が異なることを示していると思います。

68
J.K.

dirtyコードの一部です;）

98
MattyD

Wikipedia ：「問題のあるコードや誤解を招くコードを他のプログラマーに警告するためのXXX」 -「xxx」と書かれた毒の入れ物から取り出された可能性があります。スーパーオールドスクール。

TODOのメモの場合は、関連するブログ投稿 TODOまたはnot TODO と呼ばれ、GREPを使用してコメントを日付、所有者などでソートする方法を説明しています。

21
blunders

それは何も意味しません。視覚的に区別でき（視覚的にスキャンしやすく）、コードやコメント（プログラムで簡単に検索できる）に表示されにくい文字列です。

したがって、簡単に検索できる必要があるコメントにフラグを付けるためのマーカーとして使用されます。通常は、再検討が必要なコードにマークを付けます。

13
Jörg W Mittag

IIRCは、以前からあるアノテーションであり、TODOまたはFIXMEアノテーションと同じ意味です。たとえば、vimのソースではかなり一般的です。

7
Rein Henrichs

これは通常のコードでは発生しない文字シーケンスである可能性が高いため、コマンドラインから簡単に検索可能になります。

ravn:tmp ravn$ echo XXXX This is very bad > processor.c
ravn:tmp ravn$ echo XXXX Verify defaults before going in production > main.c
ravn:tmp ravn$ grep -R XXXX .
./main.c:XXXX Verify defaults before going in production
./processor.c:XXXX This is very bad
ravn:tmp ravn$

（例はUnixの場合、 "findstr"はMicrosoft Windowsでも同じだと思います）

6
user1249

しかし、XXXは一般的にどういう意味ですか？ 「これはハックだ」と言っているのでしょうか、それとも「おそらくこれを後で再検討する必要があるのでしょう」でしょうか。それとも完全に別のことを言っているのですか？

上記のいずれか。

XXXとTODOまたはFIXMEまたはHACKなどの選択は、強力なルールや規則に準拠していません。基本的に、それはそこにそれを置いた人が意味するように意図したものは何でも意味します。それは明白かもしれません...またはそれはあなたにとって完全に不透明かもしれません。

[〜＃〜] update [〜＃〜]Wikipedia 現在（2016-03-30）と言います：

そのようなタグは大きく異なりますが、次のものが含まれる場合があります。

  • ...
  • XXX-問題のあるコードまたは誤解を招くコードを他のプログラマーに警告する

元のテキストの明確な警告に注意してください。 XXXは、古典的な漫画や漫画などの毒や密造酒のボトルに見られる「XXX」の暗示として解釈できます。

4
Stephen C

それはおそらく後で見つけることができるマーカーです。 TODOやFIXMEとは異なり、XXXはWordや構文にほとんど見られないため、ファイルを検索するときに単独で使用できるマーカーとして最適です。

2
Rook

私の出身地は、まだ知らない数字にはXXX（次にYYY、ZZZ）を使用します。たとえば、XXXをYYYに追加して結果を検索し、10％を追加します。

「x」が未知の変数である学校での方程式に由来します。

0
Dimitrios Mistriotis