コメントでXXXはどういう意味ですか?[閉まっている]


72

あなたがXXXコメントで見るとき、人々は一般に何を意味します。時折、次のようなコメントが表示されます。

# XXX - This widget really should frobulate the whatsit

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


3
この質問に答えるための参考文献がたくさんあります。catb.org / jargon / html / X / XXX.html ; oracle.com/technetwork/java/javase/documentation/… ; c2.com/cgi/wiki?FixmeComment
pkh

qaz個人的に使用しています。入力しやすく、40年のコーディングで自然にコード内で発生したことはないため、簡単に検索できます。FixMe:やToDoではなく、簡単な実験的ハックに使用します。うまくいかない場合は簡単に元に戻すことができます。しかし、私の場合、ソース管理にコミットqazすることはありませんが、FixMe:またはToDo:またはXXXはコミットできます。
-Mawg

Meteorのコードベースには、古いXXXのコメントがたくさんあることに気づきました...その汚い秘密に関する実行中のコメントのようなものです。そして、彼らは何らかのツールを使用して、出荷されるコードから自動的にそれらを取り除くようです!
アンディ

回答:


68

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

ただし、このWebページには、多少異なる考え方が記載されています。

XXX:偽物だが機能するものにフラグを立てるために使用

FIXME:偽物で壊れたものにフラグを立てるために使用

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


12
HACKはの代替になりXXXます。
リチャード

1
リンクが壊れています:(
ジャック

1
FIXME: link broken
onewhaleid

1
HACKはXXXの代替ではありません。XXXコメントフラグには長い歴史があり、本質的には機能するが注意が必要なものを意味します(偽物ではありますが機能します)。
ブリルパピン

98

それは汚いコードです;)


20
これは面白い答えですか、それとも面白い正解ですか?
高円寺

4
ああ、これらのいたずらなプログラマー
-aeracode

@koenmetsu面白くて正確。それは間違っていますが、今のところ十分に機能するので、完全に間違っているわけではありません。「ダーティ」は、機能するものの完全に正しいとは言えない(クリーンな)ものの適切な説明です。
Iiridayn

21

ウィキペディアごと:「XXXは他のプログラマーに問題のあるコードや誤解しているコードを警告します。」-「xxx」と書かれた毒の容器から引き出される可能性があります。スーパーオールドスクール。

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


13

何も意味しません。視覚的に特徴的な(視覚的にスキャンしやすくする)文字列であり、コードまたはコメントに表示されることはほとんどありません(プログラムによる検索が容易です)。

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


2
また、grepのなどで見つけるのは簡単
ザカリーK

7

IIRCは、TODOまたはFIXME注釈よりも前の日付であり、同様の意味を持つ注釈です。たとえば、vimのソースでは非常に一般的です。


6

通常、通常のコードでは発生しない文字シーケンスです。つまり、コマンドラインから簡単に検索できます。

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の場合、Microsoft Windowsでも「findstr」は同じことを行うと信じています)


4

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

上記のいずれか。

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


更新 ウィキペディア(2016-03-30)現在:

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

  • ...
  • XXX-他のプログラマーに問題のあるコードや誤解しているコードについて警告する

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


2

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


0

元の場所では、XXX(およびYYY、ZZZ)を使用して、まだ知らない番号に使用します。たとえば、XXXをYYYに追加して結果を見つけ、10%を追加します。

「x」が未知の変数である学校の方程式から発生します。

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