ソースコード、どう読めばいいの?
こんにちは、こんばんは。
普段はバックエンドエンジニアでWebアプリ開発をしているiniです。
会社に入社してしばらくしてから、
2~3年稼働している社内プロジェクトに途中参加することになりました。
そこで先輩に言われたのが、
「ソースコードを読みたまえ」
でも、当時の私は「どう読めばいいのか?」もわからず、
上から下までただひたすら読んで、時間を浪費していました……。
そんな経験をもとに、この記事ではコードを読みやすくするショートカットキーをまとめておきます!
この記事を読むにあたっておすすめな人
- 駆け出しエンジニア
- VSCode / Windsurf を使ってる人
- ショートカットキーを網羅してみたい人
ショートカットキー集
@12345 さんの
VS Code の便利なショートカットキー
@TakahiRoyte さんの
【Windows版】VS Code キーボードショートカット一覧 (オススメ付き)
を参考にしていただければ全体を通してわかると思います。
ファイル間で使えるジャンプ機能
戻る・進む(ジャンプ履歴)
上の記事にはあまり触れられていなかったのですが、
操作内容 | Windows / Linux | Mac |
---|---|---|
定義へジャンプ |
Ctrl + クリック
|
Cmd + クリック
|
前に戻る |
Alt + ←
|
Ctrl + -
|
次に進む |
Alt + →
|
Ctrl + Shift + -
|
この「戻る/進む」は、複雑なプロジェクトで関数をたどった後に元の位置に戻るのに超便利です。
ファイル例
utils.py, main.py というファイルがあるとします:
# utils.py
def calculate_tax(price: float) -> float:
return price * 0.1
# main.py
from utils import calculate_tax
def show_price():
print(calculate_tax(1000))
実際の操作
calculate_tax(1000)
にカーソルを置いて Ctrl
+ クリック
(または F12) → utils.py
に飛びます。
中身確認したあと、Alt
+ ←
で main.py
に戻ります。
そのあと、再度calculate_tax(1000)
からutils.py
に飛んでもいいですし、直前のファイル(定義された場所)に戻りたい場合はAlt
+ →
を使うと楽です。
まとめ
最初は Ctrl + F
や Ctrl + Shift + F
を使ってましたが、
このジャンプショートカットを覚えてから、読むスピードがめちゃ上がりました。
※再掲
操作内容 | Windows / Linux | Mac |
---|---|---|
定義へジャンプ |
Ctrl + クリック
|
Cmd + クリック
|
前に戻る |
Alt + ←
|
Ctrl + -
|
次に進む |
Alt + →
|
Ctrl + Shift + -
|
慣れれば、
コード探索のストレスが激減し、コードリーディングのスピードが2倍近くになります!
次回は「コードの追い方・読み方」についても書く予定ですのでお楽しみに!