「リーダブルコード」より、「コードの欠陥にコメントをつける」

リーダブルコードを読んでいて、以下の表は覚えておきたいと思ったので抜粋しておく。

記法 典型的な意味
TODO: あとで手をつける
FIXME: 既知の不具合があるコード
HACK: あまりキレイじゃない解決策
XXX: 危険! 大きな問題がある

TODO:は大きな問題に使って、小さな問題にはtodo:やmaybe-later:を使うという場合もあるかもしれない

0 件のコメント:

コメントを投稿

注: コメントを投稿できるのは、このブログのメンバーだけです。

"LGPL and Java"を読んだ

JavaというかJVMを使わないといけないような気がしていて、Javaの場合にLGPLがどう働くのかが気になっていた。 LGPL and Java を読んでみた。 今まで気にしたことはなかったが、www.gnu.orgの文書は、基本的にはCreative Commo...