Chapter 06

拡張機能(コーディング支援)

karaage0703
karaage0703
2021.06.16に更新

コーディングを支援してくれる拡張機能を紹介します。

共通

コードを見やすくする

コードを見やすくしてくれる拡張機能です。

  • Bracket Pair Colorizer 2 ペアのカッコを見やすくしてくれます
  • indent-rainbow インデントに色をつけて見やすくしれくれます
  • Trailing Spaces 空白に色をつけて余計な空白の見落としを防ぎます

以下のようなコードを例に効果をみてみましょう

上記の3つの拡張機能を入れると、以下のように見やすくなります。

コードの可読性が上がり、間違い・見落としを減らせそうですね。

Git関係

Git関係の拡張機能です。これらを入れておくと、Gitと連携してパワフルな可視化ができたり、Gitの機能をVS Codeから使えたりします。以下が代表的な拡張です。

  • Git Graph
  • Git History
  • GitHub Pull Requests and Issues
  • Remote Repositories

Remote Repositoriesは比較的新しい機能で、手軽にGitHub上のソースコードをVS Code上で読めるようになるのでオススメです。詳細は以下記事参照ください。

https://forest.watch.impress.co.jp/docs/news/1331439.html

Vim拡張

VS Codeで使いなれたVimのキーバインドが使える、Vim使いの人には必須の拡張です。hjklでのカーソルの移動はもちろん:wqでのファイルのセーブと終了、ブラグインを入れないとできないはずのgccでコメントアウトとアンコメントが切り替えができたりと、痒いところに手がとどく感じでありがたいです。

かなり多くの人がメンテナンスしているようで、完成度の高さを感じます。

「Vim」で検索するとインストールできます。

キー(jklh)の連続入力でカーソルが移動できない場合は、以下実行してログオフしてログオンしましょう。

$ defaults write -g ApplePressAndHoldEnabled -bool false
$ defaults write com.microsoft.VSCode ApplePressAndHoldEnabled -bool false
$ defaults write com.microsoft.VSCodeInsiders ApplePressAndHoldEnabljed -bool false

Python関係

Lint

Lint(コーディングチェック)の拡張機能(ライブラリ)は色々あるのですが、以下はFlake8の例です。

設定画面(Settings)でPython > Linting: Enabled Python > Linting: Flake8 Enabledにチェックを入れて、Python > Linting > Pycodestyle Enabledのチェックを外しましょう(Pycodestyleはチェックしたままでも動作は問題ないのですが、PycodestyleはFlake8に含まれていて警告が2重に表示されて見づらいためチェック外しています)。

必要に応じて、Flake8のオプションを追加しましょう。

以下は、複雑度の指標の調整と、1行の文字数の調整をしています(デフォルトだと厳しすぎるので)。

--max-complexity=10
--max-line-length=127

正しくLintが動くと、以下のようにコーディング規約に沿っていないコードに警告を出してくれます。

Docstring

Python Docstring Generatorを入れると、Docstring(関数の仕様を説明するドキュメント的なリッチコメント)をある程度自動で生成できます。

関数宣言の直下で、右クリックをしてGenerate Doctringを選択するか"""を入力すると以下のように自動で挿入されます。

def resize(src, w_ratio, h_ratio):
    """[summary]

    Args:
        src ([type]): [description]
        w_ratio ([type]): [description]
        h_ratio ([type]): [description]

    Returns:
        [type]: [description]
    """

Docstringを書いておくと、VS Code上で関数の仕様を確認しやすくなったり、ドキュメントを自動生成できたりと、使う人が色々便利なので、多くの人に使ってもらうソフトや多人数で開発するソフトに関しては記載しておくことが推奨されます。

Processing

以下記事参考に設定すれば、VS CodeでProcessingのコーディングから実行までが簡単にできます。

https://qiita.com/what_a_pon/items/2897fe95c7007dd7a769