「コメントを全く書かない」プロジェクトに1年従事して思ったこと - Qiita

初めに 私はSESでエンジニアをしています。そのためいろいろな現場に参画して開発をすることが仕事なのですが、コメントを全く書かないどころかドキュメントもあんまりないという思想のチームに1年従事したときに感じた事を書いた記事です。 開発にはJava,Pythonを利用しているので、これらの言語でサンプルを記載しています。 良かったこと まずは良かったことです。大きく分けては 自身のコーディングスキルの向上 文章力の向上 の2点です。 自身のコーディングスキルの向上 コメントがまったくない。という状態でコードを書いていく場合には、変数名、メソッド名等の命名が非常に重要です。もはや命名さえちゃんとできればコーディング自体はそんなに大変でないといってもいいかもしれません。 SIerの案件ではコメントは多く書けという思想が多いです。そのため、これまでのコードは以下のような感じでした。

[yamadadadada2]

処理についてコメントするんじゃなくて、ドメイン知識や文脈についてコメントすべきだよなあと最近は考えている

[strawberryhunter]

"filteledListNumber" お前らにはコメントなしは早すぎる。

[mole-studio]

コードそれ自体を説明するコメントは不要だけど、歴史的経緯や変則的な仕様に関わるコード周りは要るでしょ

[takeag]

「困ったこと」に書いてあるものはコメントだけの問題ではない気が。

[habarhaba]

変なこだわりがある現場だな

[tama20]

コメント大事だな

[odakaho]

テストコード書けよ

[arx0balest]

"コードを読めない新人さんや、製造が久しぶりの人の為にできる情報共有はコードのみだけでなく、設計書を用いて伝える必要があります" あっ、地獄だ

[lorenz_sys]

今日のプロが書くソースコードのコメントってのはコードからは読み取りにくい情報を書くもの。コードの説明を書いてるうちは半人前。なお JavaDoc とコメントの用途を混同してはいけない。

[theatrical]

　固定的なルールは柔軟性が無いのであまり良くないかなと思う。こういう場合はコメントしよう、こういう場合はしようにしようと方針を決めて、コードレビューでアジャストしていくのがいい気がする

[roshi]

プロとして仕事をするならそういう縛りプレーは個人でやって欲しい。

[tanishiking24]

DDDっていうのがあってな

[otihateten3510]

リーダブルコードを読もう