IT エンジニア日記 ～コメントのないソース～ -2023/11/17-
どうも。他人が書いたコードやクエリが嫌いな clown です。
他人が書いたコードやクエリを読んで、これ何をしたくてこうなってるかという意図を汲み取るのが面倒って気持ちが大部分を占めてて、ドキュメントなんて今時あんまり作ってないサービスもあるし。
なんで、コメントって大切だよなーと思ったり。
サービス全体のパフォーマンスを改善する仕事をしていて、僕は余所者だから閲覧権限がないドキュメントは見られないし、そもそもそんなものがあるのか無いのかすらわからない立場でして。
なので、コメントとかの情報が無いと面倒で。
訊いたりする手間、それを咀嚼して嚥下する手間、そういうのもコストなんだよなーと考えると、コメントやドキュメントの整備ってそれなりに大切なんだよなーと思う。
支援のお願い
素材引用元
アイコン
見出し
この記事が気に入ったらサポートをしてみませんか？