多くのソフトウェア エンジニアは、検索や自動タスク追跡などで使用するために、コード コメントに追加できる特別なコメント「タグ」の使用法に精通しています。最も人気のあるものには、FIXME、TODO、UNDONE、および HACK があります。
HACK および UNDONE タグの使用法に少し混乱しています。少し助けてください?
FIXME と TODO の基本的な違いを示すためのボーナス ポイント
多くのソフトウェア エンジニアは、検索や自動タスク追跡などで使用するために、コード コメントに追加できる特別なコメント「タグ」の使用法に精通しています。最も人気のあるものには、FIXME、TODO、UNDONE、および HACK があります。
HACK および UNDONE タグの使用法に少し混乱しています。少し助けてください?
FIXME と TODO の基本的な違いを示すためのボーナス ポイント
私の理解:
TODO: やらなければならないこと。これは、後で追加される機能であるか、何かがスタブであり、実装する必要があることを示している可能性があります。
FIXME: TODO タグのサブクラスで、修正が必要な何かが壊れていることを示します。
元に戻す: 他の変更のロールバックまたは取り消しであった変更を示すメモ。このコメントは通常、削除されたものとその理由を示します。
HACK: 特定の問題を修正するために追加された、通常は奇妙または型破りなコードの一部です。これらは通常、「エレガントな」ソリューションではありませんが、それでも機能します。多くの場合、これらはフレームワークのバグやその他の予期しない動作に対処するために表示されます。さらに、コメントがなければ、コメントされたコードの目的が不明確になることがよくあります。
UNDONE は、メソッドが終了していないことを意味します。通常、内部コードがないにもかかわらず、データ型を返します
これを言いたかったのは、一部の人々がそれを逆転と見なしているためです。私はこの種のコメントでコードを汚すつもりはなく、他の多くの人々が私と同じ意味で UNDONE を使用する可能性があると感じています。
それはリベラルなルールセットですが、素晴らしいシステムです
public int SomeCalculation(int Input)
{
return 0; //UNDONE
}
public bool SomeCheck()
{
return false; //UNDONE
}