質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.51%

  • PHP

    20416questions

    PHPは、Webサイト構築に特化して開発されたプログラミング言語です。大きな特徴のひとつは、HTMLに直接プログラムを埋め込むことができるという点です。PHPを用いることで、HTMLを動的コンテンツとして出力できます。HTMLがそのままブラウザに表示されるのに対し、PHPプログラムはサーバ側で実行された結果がブラウザに表示されるため、PHPスクリプトは「サーバサイドスクリプト」と呼ばれています。

  • JavaScript

    16501questions

    JavaScriptは、プログラミング言語のひとつです。ネットスケープコミュニケーションズで開発されました。 開発当初はLiveScriptと呼ばれていましたが、業務提携していたサン・マイクロシステムズが開発したJavaが脚光を浴びていたことから、JavaScriptと改名されました。 動きのあるWebページを作ることを目的に開発されたもので、主要なWebブラウザのほとんどに搭載されています。

  • Java

    13836questions

    Javaは、1995年にサン・マイクロシステムズが開発したプログラミング言語です。表記法はC言語に似ていますが、既存のプログラミング言語の短所を踏まえていちから設計されており、最初からオブジェクト指向性を備えてデザインされています。セキュリティ面が強力であることや、ネットワーク環境での利用に向いていることが特徴です。Javaで作られたソフトウェアは基本的にいかなるプラットフォームでも作動します。

  • Python

    8053questions

    Pythonは、コードの読みやすさが特徴的なプログラミング言語の1つです。 強い型付け、動的型付けに対応しており、後方互換性がないバージョン2系とバージョン3系が使用されています。 商用製品の開発にも無料で使用でき、OSだけでなく仮想環境にも対応。Unicodeによる文字列操作をサポートしているため、日本語処理も標準で可能です。

  • Ruby

    7707questions

    Rubyはプログラミング言語のひとつで、オープンソース、オブジェクト指向のプログラミング開発に対応しています。

プログラムのコードにコメントって書かなくても良いですか?

解決済

回答 5

投稿

  • 評価
  • クリップ 0
  • VIEW 455
退会済みユーザー

退会済みユーザー

プログラムのコードにコメントが必要なケースって以下くらい、その他の場合は特にコメント書かなくても良いですか?

  • 可読性を犠牲にして計算処理を高めるような難解なアルゴリズム書いたりする時
  • TODO:やFIXME:的なコメントを残す必要がある時
  • 英語に弱い人が多いチームの場合(?)

ここで何やってますみたいなコードは、メソッド名や変数名見れば分かるので、いちいち説明しないで良いですよね?

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

質問への追記・修正、ベストアンサー選択の依頼

  • 退会済みユーザー

    2017/10/12 14:31

    複数のユーザーから「問題・課題が含まれていない質問」という意見がありました
    teratailでは、漠然とした興味から票を募るような質問や、意見の主張をすることを目的とした投稿は推奨していません。
    「編集」ボタンから編集を行い、質問の意図や解決したい課題を明確に記述していただくと回答が得られやすくなります。

回答 5

+12

僕はコメントは絶対必要だと思っています。
そして、コメントに書くべき内容というのは、そのコードが「何を」しているかではなく、
なぜ」しているかということです。
何をしているかは、よほど難解でない限りコードを見れば分かります。
知りたいのは、なぜこのコードが必要なのかってとこです。

自分のコードだったとしても1ヶ月も経てば、何でこれが必要なんだったっけ?っとなるのは
プログラマーあるあるです。

// ユーザー情報を作成
User user = new User();
// 作成したユーザーに必要な情報をセットしていく
user.setId(id);
user.setName(name);


こういうのはクソコメントですね。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+9

この辺はリーダブルコードを参照だね。
紹介されている内覚えているのは下記。

  • 複数選択肢の内、なぜこの選択肢を取ったのか
  • 勝手にリファクタリングすると大ハマリする可能性がある箇所

他にもWebStorm使っているエンジニアが居るなら、
JSDocを残しておくと補完がバシバシ効くから超絶感謝されるよ。

私はWebStorm使うエンジニア居ないから、Haskellの関数定義を見習った何かを記述するようにしてるね。
1行で簡素に書けるから関数名と合わせて簡単に使い方を思い出せて便利に感じてるよ。

// isHoge :: String -> Boolean
const isHoge = R.pipe(R.prop(a), b, R.allPass([c, d, e]))

他にはドキュメント化したりREADME.mdに残したり、
いろんな選択肢があるから、その都度考える感じかな。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+6

処理についてはコードとして書いてあるのでコメントとして残す必要性はないと思いますが、そのコードには含まれないコンテキストについては残す方が良いと思います。

私の場合には良くインシデントやバグチケット、MSDNやその他リファレンス、StackoverflowやGitHubのURLと、なぜそこを参照すべきなのかという理由を書いてます。

綺麗なコードは何をやっているか自明ですが、なぜそうしたかというコンテキストは、整える過程でコードから削ぎ落とされているはずなので。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2017/10/11 19:56

    あとHow to useもよくコメントとして残します。

    キャンセル

  • 2017/10/11 19:57

    あと見落としがちなコーナーケースも。

    キャンセル

+4

個人的な考えを記載します。
いろいろな考え方があると思いますので、参考程度にしてもらえればと思います。

・自分以外の誰かが見る可能性があるのか
・誤解が生じると影響度が高い内容なのか
・IDEなどで呼び出されるメソッドの内容が見える必要はないのか

例えば、メソッドにコメントがないフレームワークを見たことはありますでしょうか。
動作することは最低条件ではありますが、フレームワークのコードは多くの人が見て同じ理解をして頂く必要があります。
多くの人が見るという前提であれば、スキル差があるためコメントを書くことで誤解なく伝えることが必要となります。
またIDEなどを使用していれば、コードを書く時にコメントが表示されてどのような処理が行われるメソッドなのかがすぐに分かることもあると思います。

ではフレームワークではなく、とある処理の一部からしか呼ばれないプライベートなメソッドには必要無いのでしょうか。
結論から書くと必要な場合のほうが多いと思います。
もし会社など組織でコードを書いている場合は、そのコードを書いた人は永久にそのコードを保守してくれる約束はされていません。
他の誰がそれを引き継ぎ、保守しなければなりません。
その時にそこに書かれているコードの意図や思いは、コードからは読み取れないケースがあります。
あるいは動作はするが、仕様とは違うことにより、期待する結果が返されないケースなどがあると、その人は現場のコードがなぜそのようなコードになっているのか というところから考えなければなりません。

以上のようなことは、今ではなく未来になってやっと分かることかもしれません。
もしコメントを書かなくても良いと思うのでしたら、自分のためではなく人のために書いてあげると良いかもしれません。
参考になれば、幸いです。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

checkベストアンサー

+3

コメントは所詮コメントなので、「書かなくて良いか?」と聞かれれば「YES」としか
答えようがありません。
ただしプロジェクトで作業を行う限り、コメントについてもルールが設定されるはずです。
プロジェクトの方針にあわせて下さい。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 90.51%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る

  • PHP

    20416questions

    PHPは、Webサイト構築に特化して開発されたプログラミング言語です。大きな特徴のひとつは、HTMLに直接プログラムを埋め込むことができるという点です。PHPを用いることで、HTMLを動的コンテンツとして出力できます。HTMLがそのままブラウザに表示されるのに対し、PHPプログラムはサーバ側で実行された結果がブラウザに表示されるため、PHPスクリプトは「サーバサイドスクリプト」と呼ばれています。

  • JavaScript

    16501questions

    JavaScriptは、プログラミング言語のひとつです。ネットスケープコミュニケーションズで開発されました。 開発当初はLiveScriptと呼ばれていましたが、業務提携していたサン・マイクロシステムズが開発したJavaが脚光を浴びていたことから、JavaScriptと改名されました。 動きのあるWebページを作ることを目的に開発されたもので、主要なWebブラウザのほとんどに搭載されています。

  • Java

    13836questions

    Javaは、1995年にサン・マイクロシステムズが開発したプログラミング言語です。表記法はC言語に似ていますが、既存のプログラミング言語の短所を踏まえていちから設計されており、最初からオブジェクト指向性を備えてデザインされています。セキュリティ面が強力であることや、ネットワーク環境での利用に向いていることが特徴です。Javaで作られたソフトウェアは基本的にいかなるプラットフォームでも作動します。

  • Python

    8053questions

    Pythonは、コードの読みやすさが特徴的なプログラミング言語の1つです。 強い型付け、動的型付けに対応しており、後方互換性がないバージョン2系とバージョン3系が使用されています。 商用製品の開発にも無料で使用でき、OSだけでなく仮想環境にも対応。Unicodeによる文字列操作をサポートしているため、日本語処理も標準で可能です。

  • Ruby

    7707questions

    Rubyはプログラミング言語のひとつで、オープンソース、オブジェクト指向のプログラミング開発に対応しています。