2023-8-30「創業以来秘伝のソース」

2023年8月30日 23:33

プログラムソースのお話です。
ソースには「コメント」を書く機能があることが多いです。

「コメント」の部分はコンピュータは読まずに無視します。
なのでコンピュータではなく人間が読むことができるのですね。

コンピュータが読める命令部分にコメントマークをつけることで、コンピュータはそこを無視するようになります。

書き換えたときに古いソースコードをコメント化して残しておくのは、是か非か？　みたいな話題を集めてみました。

16年前の議論ですが、結論としては「バージョン管理ツールに任せて、昔のソースをいつまでも残しておくのはよくない」でもうこの頃から趨勢は決まっているようですね。ただ、まだこの頃は「わかってはいるけれどウチも残しています」「残すのもアリでは」みたいな意見も多いようです。

基本は残さない方がいいけれども例外は常にある、といった意見が多いようですね。しかしバージョン管理はツールを使うのがもはや常識ではあるようです。

こちらは履歴は残すべきだ、という主張の方ですね。

そんなルール、まだやってるの？　という感じの意見です。

これは反論とかではなくって普通に残した方がいいですよ、という内容で、なかなか興味深いです。

ワタシとしては「人に見せるためのコメントなら別に全然オッケー」ですかね。

ただ、こういうコメントを残せ、という人は多くの場合
「機械的に元に戻せるように」全部残しておいてください、
みたいなことをおっしゃることが多いです。

機械的に元に戻したいのならバージョン管理システムを使う方がいいですね。機械的にコメント化してしまうと、人が見るのにキビしいコメントでぐちゃぐちゃのものになってしまいます。

それに、コメントを残さないと修正できない、という運用にしていると、みんなできるだけ変更をしないように、変更をしないようにしてしまいます。

使わなくなったり呼ばれなくなったりした処理を削除せずにそのまま放置していたり、古くて間違っているコメントを放置したり、そういうことが平気で行われるようになります。

それはソースコードのクオリティを下げる要因になってしまうと思います。だから基本的にはワタシはコメントを残すルールは苦手です。

以上、ここまで読んでいただいてありがとうございました！

いいなと思ったら応援しよう！