プログラミングの書き方にもお作法があります。そのお作法をコーディングスタイルといいます。コーディングスタイルは守らなくても動くプログラムを書けますが、コーディングスタイルを守り、きれいに書くことも大切です。プログラムは書くことよりも他人に読まれることが多いです。二週間前の自分が書いたコードも他人が書いたコードのようなものなので、読んでわかるものを書いておくに越したことはないでしょう。
Pythonのコーディングスタイル【PEP】
PythonにはPEP8というコーディングスタイルがあります。これに従っておけば問題ないでしょう。そんなに詳細まで覚えなくてよいですが、例えば以下のような例があります。
spam(ham[1], {eggs: 2}) # 良い
spam( ham[ 1 ], { eggs: 2 }) # 悪い
このコーディングスタイルを自動でチェックしてくれる機能があります。その役割を果たすのがLinterです。vscodeで右下にいちいち出てくるのがLinterの設定です。vscode経由でインストールしてしまいましょう。Linterもパッケージなので、環境にインストールします。仮想環境でもよいですが、Linterは大体全部の環境で使うので、Python本体に入れてしまいます。Linterにもいろいろ種類がありますが、今回はflake8にします。ほかのLinterについてはこちらに詳しくのっています。
Select Linterを押しましょう。
flake8を選びます。
Installを押します。
例えばこのようにいらないスペースが入ってたりすると注意してくれます。
コーディングスタイルも自動で直してくれるパッケージがあります。直してくれるショートカットキーはデフォルトでCtrl + K, Ctrl + F
です。押してみると、コードフォーマッタをインストールするように勧められます。autopep8でよいので、Yesを押します。
このようなきちんとフォーマットされていないプログラムをフォーマットするには、全部選択してCtrl + K, Ctrl + F
を押します。
コメント