github copilotをうまく使うために先人から学べ

最近、Github Copilotを個人開発でよく使うので、ベストプラクティスを読んでいた。

Using GitHub Copilot in your IDE: Tips, tricks, and best practices
https://github.blog/2024-03-25-how-to-use-github-copilot-in-your-ide-tips-tricks-and-best-practices

読み進めると、結構、開発をしている先人たちが推奨してきた内容がじゅうようなんだなということがわかる。

コメントはしっかり残す

自分の努めている会社がということなのかもしれないが、リーダブルコードを推進していて、コードの中にコメントが書かれていないということをよく目にする。
これではこのコードの役割の大枠が理解できないではないかなんて思ったりもする。

Provide a top-level comment (トップレベルのコメントを記入する)
Provide specific and well- scoped function comments (関数コメントを具体的かつ適切に記述する)

このあたりは、ぼくと同じ世代であろうITエンジニアであれば当たり前のことだとは思うだろう。

人間もCopilotも、これらのコメントがあることで、いま書いているコードがどういった機能を持ち、どういった仕様のもの動いているのかを理解する。
一行一行には必要ないが、はじめに目にするであろうところに書かれているだけで、理解や可読性が変わってくるものなのだ。

Copilotの活用云々にも関わってくるが、忘れずに意識していきたいものだ。

不要なものは残すな

コードを書いていると、なんとなく後で使うかもしれないからと、消せないでそのままにしておくコードが合ったりする。
これも結構あるある。
以前ものすごく注意されたことがある。

Remove irrelevant requests (無関係なリクエストを削除する)

Copilotも不要なコードが有ると邪魔になってしまうのだ。
使用されていないものが残ってしまっていると、それらを使用しようとしてしまって、不具合の温床になったりする。
可読性はもちろん、Copilotがサジェスト妨げにもなるので、気をつけていきたい。

読んでみるといろんな振り返りに役立つ

もっとうまく使いたいなと思って、読んだわけだが、意外といまやっていることなどに対しての振り返りができると考えている。
また、AIといっても効率的に動いてもらうためには、丁寧なコミュニケーションが必要で、これは人間とそれほど変わらない。
丁寧にコードを書いているつもりではあるが、Copilotにしっかり動いてもらって、より効率的に開発ができるようにしなければ！