[B! コメント] riyokotterのブックマーク

riyokotter id:riyokotter

コメントに関するriyokotterのブックマーク (2)

[プログラミング]そのコメント、カッコ悪い – atuweb 開発ブログ
少し前に読んだ「情熱プログラマ」では、プログラマの必須能力のひとつとして作文技術を挙げており、とても納得しました。優れたプログラムは、ムダが少ないためにわかりやすく、そのうえ見た目にも美しいものです。これに対し、良くないコードは読みにくく、把握が困難なために見ているだけでイライラしてきます。そして、コードの良さはコメントひとつにもあらわれるものです。今回はアンチパターンとして私が「ないわー」と思ったコメントの付け方をピックアップしてみます。ノイズになっているコメント良くないコメントの 9割はノイズである by Atuweb コードをそのまま自然言語に直しただけのコメント 1// Bad: コードをそのまま自然言語に直しただけのコメント 2var $_it em_id;//アイテムID 3var $_loginid;//ログインID 4var $_pass;//パスワード
riyokotter 2016/05/10
programming

コメント

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

コーディング規約

コメント
リンク
1