【Django】VSCodeでクラスの定義を簡単に確認する方法

VSCodeでのクラス定義の確認方法の解説ページアイキャッチ

このページでは、VSCode でクラスの定義を簡単に確認する方法について解説します。

クラス名を「右クリック」→「定義へ移動」

といっても、VSCode での確認方法は非常に簡単で、この章のタイトルの通り、まず定義を調べたいクラスのクラス名を「右クリック」し、

クラスの定義の調べ方1

続いて、右クリックによって表示されるメニューから「定義へ移動」を選択すれば良いだけです。

クラスの定義の調べ方2

これだけで、右クリックしたクラスの定義を調べることが出来ます。

クラスの定義の調べ方3

クラスの定義を調べるメリット

Django では、特に Model や Form、View などに関しては、Django で標準で用意されているクラスを継承する形で別途クラスを定義する機会が非常に多いです。

標準のクラスを継承して独自のクラスを作成する様子

そして、その継承元のクラスからクラス変数を追加したり、メソッドを追加・上書きしたりすることで別のクラスとして仕上げていくことが多いです。

例えば、下記ページでも紹介していますが、ユーザーを管理するクラス(Model)であれば、AbstractUser を継承する形で別のクラスの定義を追加し、更に追加したクラスのクラス変数やメソッドを追加したり上書きしたりすることで、アプリに応じてユーザーを管理するクラスを作成していくことができます。

【Django】カスタムユーザー(独自のユーザー)の作り方【AbstractUser編】【Django】カスタムユーザー(独自のユーザー)の作り方【AbstractUser編】

こういったことを行う際には、継承元のクラスに、どのようなクラス変数やメソッドが用意されているのかをあらかじめ調べる必要があります。

例えばメソッドのオーバーライドを行おうと思っても、そもそも継承元にどんなメソッドが存在するかを知らないとオーバーライドのしようがありませんよね?

継承してクラスを開発するときに疑問に思うこと

そんな時に、クラス名を「右クリック」→「定義へ移動」 で紹介した手順でクラスの定義を調べることが出来れば、用意されているクラス変数やメソッドを簡単に確認することができ、これによって当然アプリの開発も楽になります。

Django の解説記事なども非常に多く公開されていますが、こういった記事もクラスの定義を調べながら作成されているものが多いのではないかと思います。私も必死でクラスの定義を調べながら記事を作成しています。

逆に言えば、クラスの定義をしっかり調べる癖がつけば、ググったりしなくても自身で解決策を見出すことも出来るようになると思います!クラス定義の調べ方と、クラス定義を調べる必要性についてはしっかり覚えておくと良いと思います。

スポンサーリンク

まとめ

このページでは、VSCode でクラスの定義を簡単に確認する方法について解説しました!

Django では標準で用意されているクラスを継承しながら別のクラスを作成する機会が多く、標準で用意されているクラスの定義の調べ方が重要であると考え、このページを作成することにしました。

もちろん Django 全体のことをしっかり理解する必要はないとは思っていますが、継承するクラスの定義については随時必要に応じて調べながら開発をした方が開発効率は上がるのではないかと思います。

また今回は、私が利用しているのが VSCode なので VSCode での手順を解説しましたが、他の開発環境でもクラスの定義を調べる手段が用意されていると思います。

ですので、他の開発環境を利用している方も、是非そういった手段を利用しながら効率的に Django での開発に取り組んでいただければと思います!

同じカテゴリのページ一覧を表示

コメントを残す

メールアドレスが公開されることはありません。