File10.仕事における親切

お疲れ様です。ERP事業部大阪開発部の田原です。

最近、同期の文系男にそそのかされてゴルフクラブを一式買いました。

なので仕方なく毎週打ちっぱなしにいって練習をし、平日にはYoutubeで動画をみて勉強し、年末には親戚とゴルフのラウンドも回る予定です。

さて、今回は実務に入って改めて自分が大切だなと思ったことを1点紹介しようと思います。

それはプログラムを書く際のコメントのありがたさです。

コメントの記述

上記はコメントがないときとある時の比較です。下の写真は親切なコードですね。

写真のようなコードだと比較的簡単なのでコメントがなくても理解は可能ですが、実務で扱うようなレベルのコードになると難しいです。

私は最近ちょっと複雑なソースコードのカスタマイズ作業に携わりました。コードを読むところからスタートしたのですが、要所要所に書かれているコメントに半分以上は助けられた気がします。

コメントはメモのように自分がわかるように書いてたことが多かったですが、後からソースコードを修正する人が理解しやすくなるためにもわかりやすく親切に書くことも一つの技術だと感じました。

おわりに

仕事で扱うようなプログラムのソースコードは場合によっては何人もの人がカスタマイズを施しているものもあるので、改めて万人が理解できる文章力って必要なんだなと思いました。

最近寒くなってきているので、皆さん体調には気を付けましょう。私は暖房器具が家にないので直ちに対処しないとまずい冬になりそうです。