最近コード中のTODOコメントの書き方を工夫している - $shibayu36->blog;
コード中に後でやろうと思って以下の様なTODOコメントを書くことがあります。TODOコメントというのは # TODO: 後でリファクタリングしたい ... # TODO: 投稿機能ができたら置き換えること ... みたいなやつです。 コード中にTODOコメントを気軽に書いてしまいがちですが、よくTODOコメントが放置されて気づいたらプロジェクト中に大量のTODOコメントが書かれたりすることがあります。直せる量を超えてくると、直すモチベーションも下がってきて、結局ただのコメントと同じ状態になります。 最近いろいろ工夫して、TODOコメントの書き方を変えたところ、そこそこうまく回ったのでメモしておきます。 TODOコメントの問題点 問題点として次のものがあると考えました。 (1) 書く人によって形式がバラバラ TODO, XXX, FIXMEなどバラバラだったりする (2) TODOコメントの
「いいから黙ってコメント書け」という話 - miauのブログ
めずらしく釣りっぽいタイトルだけど、ちゃんと主張しておきたいので。 きっかけはこちらの記事。 極論すると、コメントが無いと読めないコードはダメ - かおるんダイアリー ここから色々リンクを辿ってみたけど、ほとんどの人が コメントを書かなくてもいいよう、十分明確なコードを書く 関数やメソッド名として切り出せば、その名称で示すことができるからコメントは要らない 処理からでは読み取れない情報（意図）や、複雑な処理のみ例外的にコメントを書く あたりに結論づけているのにちょっと危機感を覚えました。もちろん「コメントを書かなくても読み取れるようなコードを書く」というのはコーディングする上で大切なことだけど、じゃあ実際にコメントを書かなくてもいいのか、というと別問題でしょう。 私のスタンスは表題のとおり「いいから黙ってコメント書け」というもの。結論としては、 コードコメントに書くべきは「意図」 - プロ
嘘のコメントを減らす努力 - Cube Lilac
見やすいコード表記について - タコブネ開発者ブログ と言う記事が目に留まったので今回はプログラミングのコメントについて． プログラミングの可読性に関する議論は，個々の宗教に依るところも大きいので非常に難しいところです．前述した記事に書かれていた内容に関しては，その多くは「プロジェクト内で統一されていれば（どちらの表記が可読性に優れているか等の議論は）どうでも良い」程度の感想しかないなのですが，一点だけ気になった部分がありました． 以下，少し長いですが引用します． SampleDTO sampleDto = (SampleDTO)testTableDAO.getPrimaryKey(dataDto.getId(),dataDto.getSubId(),dataDto.getStartDate(),dataDetailDto.getLineNo()); この長文について「1文が長過ぎるので読
コメント不要論の補足 - ひしだまの変更履歴
ひしだまＨＰの更新履歴。 主にＴＲＰＧリプレイの元ネタ集、プログラミング技術メモと自作ソフト、好きなゲームや音楽です。 コメント不要論の部分、言葉足らずでまとまりを欠いている気がするので、ちょっと補足しておきたい。 言いたいことをまともに書こうとするとコメント関連だけでまた1ページ行っちゃいそうなので、とりあえず覚え書きということで＾＾； 以下、主にJavaがターゲット。 コメントが全て全く要らないというわけではない。“適切な”コメントを書くべきだ、という事に異存は無い。 適切な変数名やクラス名・メソッド名を付けるのが大変なのと同様、適切なコメントを書くのは大変。けっこう労力（時間）がかかる。 コメントを書くのは、プログラムをコーディングする能力とは別で、日本語の文章を簡潔に書く能力が必要。 メソッド本体が1行しか無いようなメソッドでもJavadocコメントが数行になったりする事もある。実
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
