プログラムのコメントについて

いい加減、Djangoの話も書かないといけないのですが、

あんまりやっていませんorz

理由は、Ｅ資格の勉強をはじめちゃったからw

人間の時間がいかに有限か実感できる瞬間です。

（ボウリングする時間減らせばもう少しできる気もするが、

大事な運動なのでダメですｗ）

さて、今回は資格の勉強は置いておいて

少し難しい論争が職場であったのでみなさんにも共有したく書いています。

それは、

「プログラムにコメントをどれだけ書くか？」

です。

これはある意味永遠の課題なのではないか？

と感じている問題なのですが、あえて書こうと思いました。

まぁ、ここでは私の持論を書きます。

私は、

　メソッドに関しては原則書くようにしています。

　（ただし、JAVAにあるgetやputメソッドに書かないことはある）

　途中のコーディングに関してはまちまちです。

　大きな分岐だったりしたら書くことが多いと思っていますが、

　コードの途中でしょっちゅうコメントがあるのも気持ちが悪いと思っているので

　多くの頻度はないとかなって感じです。

メソッドにコメントを書く理由

理由としては、

　メソッド自体は、コードをすべて読まないとどういったものか説明できないから

　書くようにしています。

　このコメント書く、書かないに関しては、読めばわかるからいらない！

　みたいな意見がよくあると思います。

　（私の職場もありました）

　こんなことは当然です。むしろ読んでわからないコードがあったほうが問題です。

　ですが、読めばわかるから書かないけど、全部読まないと理解できないという

　ことは問題にはならないのでしょうか？

　プログラムだけでなく、いかなる資料、読み物を考えていても

　100％を理解するには読むしかありません。

　ですが、50％を理解するために概要があったり、見出しがあるものです。

　興味を引くためにあるケースもあるでしょう。

　コードも同じであるべきです。

　コードも私たちプログラマーがいる以上、「読み物」だと思っています。

　コメントがなくても当然読めるし、作った人なら大体ここら辺にあるかな？

　といった感じで触れるでしょう。

　一般的な開発現場は複数人にかかわっていることもあるし、

　大型改修のために臨時で人が入ってきているということもあるでしょう。

　このときにコメントがある程度あるだけでも読む人の補佐する役割としては、

　十分役割を果たせると思います。

　コメントがあることでメンテナンス性があがる期待をして書くようにしています。

 

デメリット

　いいことばかり書きましたが、当然面倒な点もあります。

　それは、ちゃんと更新しないと意味がないことです。

　いろんなことが重なって当初とは違うことになっているメソッドがあったり、

　実は使われていないっていうことがあるでしょう。

　改修するときにしっかりとコメントも更新しないと

　一気に役にたたないものになります。

　こういうのがたくさんあるとコメントを頼りにしなくなり、

　どんどん書かなくなるんだなっと感じています。

　（私の現場もたまにある）

最後に

コメントについて自論を書かせてもらいました。

gitに上げているコードはまだあまり書いてないから少しずつ書いていこうかな

と思っています。

みなさんも一度メンバーと突き合わせて話してみるとコメントに困らなくなると思いますよ！

Djangoはいろいろあって業務で使うようになったので

仕事しながら新しい知識をいれてこのブログに書こうかなと思っています。