IT エンジニア日記 ～プログラムソースに書いてほしいこと～ -2024/09/18-
どうも。ドキュメントがまるで無い現場で働いている CLOWN です。
ドキュメントが充実している現場、まるでドキュメントが無い現場、中途半端なドキュメントがある所為でかえってわけがわからない現場。いろいろ経験している。
そんな僕。
ドキュメントがある現場でも無い現場でも、プログラムを書くときに気を付けているのは、コメントを残すこと。
なんでこういうロジックなのか？なんでこういう処理の仕方をしているのか？どういう理由でこうなっているのか？をわかるようにしておきたい。
自分だって忘れるし、ゼロベースの他人が読んだらさっぱりわからないってことを体験として知っているから。
その気持ちで、今日もソースコードにコメントを書く。
あんまり冗長だと読むのが面倒になるから、そこは気を付けて長文にならないよう意識したり、箇条書きを使ったりとかする。
ドキュメントがまるで無いって現場に問題があることは当然で、だからと言ってドキュメント文化を導入したところで継続できなければ意味がないし。中途半端なものしか作れないなら、作らない方が工数も削減できていいだろうし。なので、ソースにもコメントを残すことを意識してる。
新しい現場って、なんなら全部ゼロベースになるからドキュメントって大切だなと思う。
作ってる人とかのもう知ってる側からしたら作るのが面倒なだけな作業だってこともわかる。
それでも効率とか工数削減とか親切（ここ大事）とかいろいろ考えるとドキュメントを導入して、ちゃんと更新する文化って必要だなと思う。あとやっぱりソースにもコメントがあるとありがたいと思う。
今のところ、ソースに有効なコメントが書かれている現場って見たことがない。
そして今日も生きてる価値を感じない。
掲げている使命
好きとスキルを駆使して、心身と経済が豊かな日本社会を創造する
いま、目の前で困っていることがある方のために僕の「好き」と「スキル」がお役にたつかもしれません。
こちら（↓）の自己紹介で僕の得意を書いていますので、お困り事のある方は、コメントをいただけるとありがたいです。
支援のお願い
本記事は無料でお読みいただけますが、投げ銭形式にしているので、気に入ったらご購入いただけると嬉しいです。
また、下記リンクのご支援をいただけると励みになります。
素材引用元
アイコン
見出し
ここから先は
¥ 300
この記事が気に入ったらサポートをしてみませんか？