web-dev-qa-db-ja.com

ビジュアルスタジオのトークン：HACK、TODO ...他にありますか？

visual Studioで役立つトークンは何ですか？ （ビジュアルスタジオ2010→環境→タスクリスト→トークン）

現在私が持っているのは：

  • [〜＃〜]ハック[〜＃〜]-低
  • レビュー-高
  • [〜＃〜] todo [〜＃〜]-通常
  • WTF-高

（これらのみ-一部のデフォルトのものを削除）

他に使用していますか？

コメントトークンで他の重要なことをカバーしていますか？

ベストプラクティスはありますか？ thnx

visual-studioconfigurationtoken
48
b0x0rz

これが私が使うものです：

  • [〜＃〜] todo [〜＃〜]：機能はまだ実装されていません
  • [〜＃〜] fixme [〜＃〜]：いくつかの目標（より高い保守性、より良いパフォーマンスなど）を達成するためにコードを修正/リファクタリングする必要があります
  • [〜＃〜]バグ[〜＃〜]：コードには既知のバグがあります
26
Enrico Campidoglio

上記のトークンのほとんどを組み合わせました。

 RED: code that simply does not work / compile
 // Error - This code is throwing a specific reproducible error.
 // Broken - This code is broken and will not run.
 // WTF - WHAT THE FRIG.

 ORANGE: code that works but is not right
 // Hack - This code has intentionally been hacked in order to work. Should not go into production.
 // FixMe - This code works but could be better. Needs better abstraction, maintainability, performance, etc.
 // Bug - This code works and was expected to be right but a bug has been found. (usually flagged post production)
 // Review - This code is probably right but should be reviewed for piece of mind.
 // Smells - Same as FixMe

 BLUE: code that works but either needs more features or more explaining
 // Todo - Functionality is not yet implemented
 // Note - Better explain what's going on. This is gives a higher profile to standard comments, and allows notes to be found in the to-do pane.
25
Chase Florell

Token REMOVEが好きです。これは、テスト専用であり、最終リリースには含めないようにしてください。

9
KevinA

別の組み込みはNOTEです。

7
Tim Lloyd

Vimは自動的にXXXをハイライト表示します。これはたまたま入力しやすいという私の選択したトークンです。

Sunの（古い）Javaコーディング規約 これは、

コメントでXXXを使用して、偽の機能するものにフラグを付けます。 FIXMEを使用して、不正で壊れているものにフラグを付けます。

5
Mark Rushakoff