0
2

More than 1 year has passed since last update.

[Rails]実務のコードは膨大すぎて大変だった。全体のコードの把握するためのコツとは。

Posted at

実務のコードは膨大すぎて大変だった!

Railsで下記のサービスを作ったことはありますが、やはり、実務としてのコードは膨大すぎて、初めて実務に入った時は大変な思いをしました。

私だけがわからなかったことかもしれませんが、膨大なコードを把握するために知っておくといい項目をいくつかまとめてみようかと思います。

環境

  • Rails
  • VSCode
  • macOS

Railsのコードの動きの把握

最初にRailsのコードの把握するコツを紹介します。

どこにも定義されてないメソッドについて

例えばpost_controller.rbに定義されてないのに使われているメソッドがありますね。
それは主にmodelで定義されたメソッドgem専用のメソッドの可能性が高いです。

まずはpost_controller.rbなので、model/post.rbを調べてみましょう。モデルメソッドがコントローラーで使われているかもしれません。
そして初心者なので、全てのgemを把握しているわけではないので、モデルメソッドではない場合はGoogle検索してみましょう。

メソッドがどこに定義されているかをVScodeで検索する方法としては下記の虫眼鏡アイコンか、command+shift+fになります。
この検索機能を利用して、どこで定義されたのか、他ではどういうふうに使われているのかが確認できます。
image.png

ちなみに、Javascirptではお馴染みのgo to definition(F12キー)はrailsではデフォルトではないようで下記の記事に沿って設定を行うとF12キーでメソッドジャンプができるようになります。

そしてRailsはDBのテーブルごとに役割がわかりやすく分けられているので、
VSCodeでcommand+'P'でファイルの検索すると、作業効率が上がります。

viewで話からないメソッドはhelperdecoraterを見てみよう!

viewでもどこに定義されているかわからないメソッドがあります。
その時はhelperファイルとdecorateファイルを確認しましょう。
詳しい説明は下記の記事を読んでいただければなと思います。

schema.rbファイルを読んでみよう!

上にもお話ししましたが、テーブルごとに役割が分かれているので、Schema.rbファイルを読んでみると、大体の動きがわかります。

routes.rbファイルも読んでみよう!

routes.rbファイルは学習でも結構慣れてきたと思いますが、私にとっては全体の動きを把握するために結構読んでました。

最後に

Railsはとても便利ですが、その分、省略されすぎていてむしろわかりにくくなる!というのが駆け出しエンジニアの私が感じたことです。
自動importよりReactみたいにimportを明記してくれればわかりやすいなと思ったりもしますが、慣れてくるとサービス全体の動きが把握しやすいフレームワークだと思います。

この記事はここまでにしたいと思います。
ご指摘や、その他のコードの動きの把握のコツがございましたら、教えてください。

0
2
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
2