たびたびTwitterなどで話題になる、ソースコードのコメント。今回はこのコメントについて、取り上げてみたいと思います。
まず、コメントとは何かという点について一応。コメントとはソースコード中に書かれるメモのようなもので、それ自体は処理に影響を与えません。基本的には該当の処理が何をやってるのかというよりは、なぜそのロジックがあるのかとか設定値の注意事項などを、書くのが望ましいとされています。
【【プログラミング初心者】コメントを書くとき知っておきたいこと】
https://eng-entrance.com/commentout
こういうコメントはイケてないという、アンチプラクティスは下記の記事にまとめられています。私の前の現場は、改訂履歴がコメントで書かれてたり、コメント内容がソースでかあ書かれている処理と合ってなかったりして、ソースの可読性がイマイチでした。。
【コメントの9割は無駄！～アンチプラクティスから学ぶ洗練されたコメントの書き方～ #code #コード】
https://next.rikunabi.com/journal/20131216_t21_iq/
処理は極力コードで表現するのが望ましいと上記で書きましたが、他の人でも理解しやすいコードを書くのは中々難しく、変数名とかも工夫する必要もあります。そんなときは、なるべく下記の記事にある「意図」を意識したコメントを、適宜入れていくのも、有効かなと感じます。
【「正しく書かれたソースコードにコメントは必要ない」なんて幻想だという話】
https://t-tutiya.hatenablog.com/entry/20170519/1495197904
