回答:
XXX
コメントは通常、前向きです。かもしれない:
FIXME
or TODO
やのようなより説明的なタグを好むことがよくありHACK
ます。XXX
上記のすべてのキャッチとしてよく使用されます。
FreeBSDコードの相互参照で「XXX」を検索することは、多くの使用法の良い例です。何千もの...
TODO
またはXXX
代わりに使用します)が、それは私がそれを解釈する方法です。
NOTE
:コードの動作の説明(自明ではない場合)。XXX
:潜在的な落とし穴に関する警告NOTE:XXX:
。として使用できます。HACK
:問題/バグを回避するためにあまりよく書かれていないか、または不正なコード。として使用する必要がありますHACK:FIXME:
。FIXME
:これはうまくいきますが、もっとうまくいくかもしれません。(通常、急いで書かれたコードは書き換えが必要です)。BUG
:ここに問題があります。TODO
:問題ありませんが、通常、何かをスキップする場合は、追加のコードを記述する必要があります。少なくとも、これは私がこれらのタグについて教えられた方法です。基本的に、最初の2つ(NOTE
およびXXX
)は情報のために使用され、アクションは必要ありません。最後の3つ(FIXME
、BUG
およびTODO
)にはアクションが必要です。HACK
中間にあります(そして、ほとんど使用されていないと思いますか?)。
LAZY
(OCD
FIXME やHACKほど重要ではない)と(オーバーエンジニアリングで知られている)も好きです。
拒否された2005年6月のPython拡張提案の一部のメモ。
間を選択する
FIXME
とXXX
難しいです。
XXX
より一般的であるようですが、説明ははるかに少ないです。
さらに、 不明な値を持つXXX
コードの一部の便利なプレースホルダーです
。したがって
FIXME
、優先されるスペルです。
Sunは、XXX
それFIXME
は少し異なり、XXX
より深刻度が高いと言っています。
ただし、このトピックに関する数十年の混乱と
、Sunの影響を受けない数百万の開発者がいるため、それらを同義語と呼ぶのは簡単です。
PEPの始まりは、
このPEPは拒否されました。コミュニティは興味を持っているかもしれませんが
、標準ライブラリをこの標準に準拠させる必要はありません。
...
コードタグとは?
プログラマーは、アドホックコードコメントマークアップ規則を広く使用して、綿密な検査またはレビューが必要なコードセクションのリマインダーとして機能します。マークアップの例としては
FIXME
、TODO
、XXX
、BUG
、しかし、既存のソフトウェアで広く使用されているが、より多くの。このようなマークアップは、今後コードタグと呼ばれます。これらのコードタグは、アプリケーションコード、単体テスト、スクリプト、一般的なドキュメント、または適切な場所に表示されます。
PEPは興味深い読み物です。
見ていPEP350を。それは、すべての説明TODO
、XXX
私はコードタグ手段のまさに1を思い出すことができないときなど、私はそれを日常的に使用します。
おそらくそれはあなたがどう対処するか分からない場合のためです。
これをチェックしてください:TODO / FIXME / XXX / HACKステートメントのリストビュー
代替テキストhttp://editra-plugins.googlecode.com/svn/wiki/images/commentbrowser/cb_screenshot.PNG
(古い)Javaコード規約から:
コメントでXXXを使用して、偽の機能するものにフラグを付けます。FIXMEを使用して、偽で壊れているものにフラグを付けます。
私FIXME
は開発者のHACK
ためであり、メンテナーのXXX
ためであり、ユーザーのためであると信じています。
たとえば、を無視してXXX
他の場所でこの関数を呼び出すと、その機能を理解していないと、予期しないことが起こり、この問題に対処する人は不幸になります(少なくとも、そのXXX
ように考えている人はそう思います)。この関数を使用しない場合、問題はなくなると思うかもしれません。
しかしについてFIXME
は、コードを修正して機能させるだけの価値があります。のためにHACK
、それを使用しなくても、より良い選択がない場合があります。
XXX
自分のコードで書いて誰かがそれを使用した場合、そのコードを完全に書き直した後、まったく異なる方法で動作し、他の誰かのコードを壊したなどの理由で不満を感じるかもしれません。しかし、あなたが去ったFIXME
か、TODO
代わりに、あなたはそれほど気にしないでしょう。