【メモ】他人が書いたソースコードを読むときのアレコレ

はじめに

業務中にソースコードを読んでいると、以下の問題が発生する。

  • 一つの機能を追いすぎる
  • そもそも自分が何を目的に読んでいたのか途中で分からなくなる/忘れる
  • オブジェクト間のデータの受け渡しの流れが分からなくなる

これらの問題をどうにか解消したいと思い、参考になりそう記事を探した。

後で自分が読み返すようにメモとして残しておく。

 

リンク集

qiita.com

www.itmedia.co.jp

medium.com

 

せっかくなので、自分がプライベートで使用頻度が高いGoのソースコードの読み方も調べた。

devblog.thebase.in

 

まとめ

とりあえずメモを取るところから始めようかな。。。

 

おまけ

実際に自分が業務でソースコードを読むにあたって、苦労したこともメモとして残しておく。

 

ドキュメントが無い or メンテナンスが止まっている

あるあるだと思います。

使用しているフレームワーク(自家製)、ライブラリ(自家製)のドキュメントが無かったりメンテナンスが止まっている。

原因不明のバグを踏んだ時は、ひたすらデバッグモードで動作を追いかけるしかなくなる。

 

(社内ツールとかの)ソースコードをプロジェクト・パッケージ単位で残しておいてくれない

複数のフォルダに分けて1ファイルずつネットワークドライブに保管していたりする。なんで?

 

ソースコードのコピーが大量に作られている

↓みたいなのも見かける。ちなみに最新の日付が最新とは限らない。

tool_A.sh

tool_A_20220819.sh

tool_A_20220820.sh