2024-10-03

ソースコードコメントは(基本的に)いらない

「読みやすコードを書きましょう」

とかそういう低レベルの話では無く、書いても書かなくても同じだから

そもそも読みにくいコードを書く人は情報の整理ができてないかコメントも読みにくい。

コメント書くぐらい労力少ないし良いのでは?」

という人も多いけど、コメントを書くとコメント実装とあってるかどうか確認しないといけないし

実装を変えたときコメント修正する必要がある。

おまけにコメント実装と合ってるかどうかは人間がチェックする必要があって機械的にできない。

最近はChatGPTに書かせてる」

かいう人もいるし、現にCopilotだとTab一発でコメントを入れられるんだけど

だったら分からないところを読むときにChatGPTに聞けばいいのでコメント意味が無い。

とはいえ、例えば外部API呼び出しの制約上致し方なくやってるとことか、将来的な方針なんかはコメントで残す方が良いので

全く必要ないとは言わないけれど、全ての行にコメント付けられると鬱陶しいだけじゃなくてメンテナンスが大変になる。

  • 全く必要ないとは言わないけれど、全ての行にコメント付けられると鬱陶しいだけじゃなくてメンテナンスが大変になる。 それはコメントの是非の話ではなく全ての行にコメントをつ...

  • コードが何をしているかという最低レベルの説明は普通いらないんだよな、そこに書いてあるから。パット見て分からない変なことをしている場合に備忘として必要なぐらい。いるのは...

  • コードを描くことがそのままドキュメント作る事も兼ねてるようなやつだと 我ながらアホっぽいなぁと思いながらget***に***を取得みたいなコメント書くはめになってるw

  • メソッドやクラスの目的は書いといてほしいな 目的が改修で変わることってまあ無いはずだし

  • 数理モデルに関するコードを書くんだけど、変数名を一文字にしたいから変数定義時に全部コメントで説明してるワイ

    • なんでも変数を1文字にする数学の風習よくないと思う

      • 数式は一文字じゃないと誤認する糞フォーマットだからしょうがないけど プログラムにするときはちゃんと書けよと思う

記事への反応(ブックマークコメント)

ログイン ユーザー登録
ようこそ ゲスト さん