PC夏休みスペシャル 2024 iPhoneで3Dモデルを手軽に作成、無料の純正アプリ「Reality Composer」を試す 2024.08.09
Method Comment（メソッドのコメント） - Strategic Choice
師曰くコードから容易に読み取ることのできない情報を伝えるためにメソッドにコメントをつけなさい。どういうこと？「名前」と「コードの構造」で、できるだけ多くの情報を表現すべきです。コメントは「コードからははっきり伝わらない情報」を表現するために追加するようにします。この指針に従い、必要と思われる箇所で、メソッドやクラスの目的を説明するJavadocコメントを追加します。どうして？意図が伝わるように書かれたコードでは、多くのコメントが不必要な「重複」になっています。コメントを書くコスト、コメントとコードの一貫性を維持するコストに見合うだけの価値をもたらしていません。コードとコメントでDRY原則違反を犯しているのです。よって、コードで表現できない、そのコードがそうなっている「理由」をコメントに書くようにします。どうすれば？この実装パターンにおいては、コミュニケーションこそが最重要の価値です。メソッ
第8回 コメントは人のためならず
プログラミングと言えば，どうしても実質的な処理を行うソースコードが注目される。が，忘れちゃあいけない。「コメント」という地味～な存在のあることを――。ソースを書くのも読むのも人間だ。機械に伝える命令を，人間にも正しく伝えなければいけない。ってことで，コメントについて調査した。 コメントはヒトのためにある 世の中には，実にたくさんのプログラミング言語がある。記号的な言語，文章のような言語，数式のような言語…それぞれに仕様が異なる。ある言語を習得したからといって，他の言語がすぐにわかるわけではない。 守備範囲も様々だ。経理などの事務処理に向いた言語は三角関数などの数学的な処理に弱かったり，人工知能向けの言語で販売管理はちょっと無理だったり…。 当然，使われる命令語や記号類も，微妙に似ていたり，時には同じだったりもするが，基本的には異なっている。ある言語では当たり前のように搭載されている命令が，
小野和俊のブログ:ソースコードのコメント率は20%を切ることが望ましい
大学の研究室の教官は昔NTT研究所の所長をされていた苗村先生という人で(と言いつつ私は大学の研究室にほとんど顔を出していなかったのだけれど)、彼の発言のうち印象に残っているものの一つとして、昔はソースコードのコメント率が50%を切るものはドキュメント不足で品質が低いものとされた、という内容のものがあった。 今、改めて考えて、どのような言語であってもどのようなコーディング規約であっても、私はソースコードのコメント率は原則20%を切ることが望ましいと思う。可読性の意味でもメンテナビリティの意味でも、開発生産性の意味でも。私が考えるに、本来コンピュータが読むためのものであるソースコードに人が読むためのコメントを付け加えなければならないのは、次の２通りの場合だけである。 1.公開されるAPI APIやソースコードそのものが公開される場合、利用者は不特定多数となり、利用者のスキルにもばらつきが出て、
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
サービス終了のお知らせ
