最近コード中のTODOコメントの書き方を工夫している - $shibayu36->blog;

コード中に後でやろうと思って以下の様なTODOコメントを書くことがあります。TODOコメントというのは # TODO: 後でリファクタリングしたい ... # TODO: 投稿機能ができたら置き換えること ... みたいなやつです。 コード中にTODOコメントを気軽に書いてしまいがちですが、よくTODOコメントが放置されて気づいたらプロジェクト中に大量のTODOコメントが書かれたりすることがあります。直せる量を超えてくると、直すモチベーションも下がってきて、結局ただのコメントと同じ状態になります。 最近いろいろ工夫して、TODOコメントの書き方を変えたところ、そこそこうまく回ったのでメモしておきます。 TODOコメントの問題点 問題点として次のものがあると考えました。 (1) 書く人によって形式がバラバラ TODO, XXX, FIXMEなどバラバラだったりする (2) TODOコメントの

[shiba_yu36]

TODOコメントについて書きました。githubのissueとコード上のTODOコメントの使い分けについても追記して補足しました。

[daaaaaai]

なんとなく書いていたけれどチームで統一するの便利。業務アプリなどの場合、画面にTODOを表示しておくと、ビジネスサイドもちゃんと伝わってるなとわかって安心しがち

[sylvan_l]

最近コード中のTODOコメントの書き方を工夫している

[tuki0918]

CIでバーンダウンチャート作るアイデア良い

[mattn]

僕は名前を入れるかな。 TODO(mattn) description

[mfks17]

参考

[masayoshinym]

期限付きにするって発想は無かった。真似したい。

[foostan]

IDEAとかはTODOウインドウあるぐらいだし、見習って活用してきたい。

[geta6]

期限フォーマットよさそう、eslintでno-warning-commentsしてて存在には気づけてるんだけどなんでfixme打ったのか忘れることよくある

[joe-re]

よさそう

[golden_eggg]

チケット化してそのURLを貼り付ける派だな。その上でメンバー全員がそのチケットを閲覧できて、メンバー全員に内容が共有出来ている状態になるまでを重視してる

[src256]

あとでやり方を忘れないならいいかも

[ryonext]

良い試みだなぁ

[michiomochi]

形式を決めるの良さそう。

[yoshikidz]

TODO書いちゃうよねー。消すのかどうか自分でもあってるのかどうかたまに忘れるw

[yasuharu519]

なるほど

[kgrock]

最近コード中のTODOコメントの書き方を工夫している

[masudaK]

あまり自分は使わないようにしてるけど、たまに見たりする。直す箇所がすぐ分かるという意味ではコメントいいのかなぁ。

[key_amb]

なるほど。

[progrhyme]

なるほど。

[pmint]

そういうコメント内でこそLTSVの出番

[nntsugu]

あるリリースまでに解決しないといけないことは、チケットを切ってバックログに積み、Versionを付けておくなりして1箇所に集約したほうが安全かな。"@TODO チケットのURL"とすると現状も確認便利かも。 "リファクタリングし

[ledsun]

「本当は直したいけど、今回は〇〇な事情で見逃す」って理由の方を書いてほしい。期限までに直せなかったTODOコメントが残ったらどうするのか？

[bellonieta]

エディタのTODO一覧系プラグイン使えばわかるけど、FIXMEがバグ（絶対修正）、TODOがタスク（機能追加など）、FIXMEが「いつかやる」でしょ。

[takc923]

必ずやらないといけない期限が決まってるTODOはチケット化してる

[masa0x80]

なるほどなー

[yoshiko_pg]

よさそう