Bot

仮想通貨botの開発記録#52(2024/2/8)「エラーに対処する根本的な方法を身につける:公式ドキュメントの読み方」

前回の記事に引き続き、今回も仮想通貨botの開発状況をまとめていきます。

プログラミングをしていると開発の途中でエラーメッセージが何度も出てきます。

例えば、仮想通貨Botの開発において特定のライブラリを使っていると各メソッド(関数)の使用が上手くいかないことがあります。

そのメソッド(関数)の理解が曖昧だと、そもそもエラーが出た時の根本的な解決方法に至ることができません。

この原因は「メソッドを表面的にしか理解していないため、各エラーの場当たり的な解決方法にとどまっていること」にあります。

そこで、「エンジニアはエラーに対処するためにどのような行動をしているのか?」を調べました。

Yodaka

エラーに対処する方法を身につけることは、Bot開発において長期的なメリットをもたらしてくれるはずです。

エラーが起きたらまずやるべきこと

  • 公式ドキュメントを読む
  • Githubのソースコードに目を通す
  • GithubのIssuesにも目を通す
  • 問題となっている事象をGoogle検索する
  • それに対する質問もStackOverflowで検索する
Yodaka

私はこれをかなりいい加減にやってたため「公式ドキュメントをきちんと読む」というのは「具体的に何をすることなのか」という点に絞って整理しました。

公式ドキュメントの読み方

Yodaka

公式ドキュメントを実用的に使うためには、実際に手を動かして段階的に理解すると良いです。

  • 試してみて動かす
  • 次に概念を体系的に理解する
  • それから実例と利用できる資源を網羅的に把握する
  • 最後に実践の機会を作って体得する

「定義」での理解をする

Yodaka

理解を深めるために、自分自身で定義づけしながらコードを書くと良いです。自身の中に明確な定義付けがあると、応用範囲が広がります。

  • リファレンスのみを見てコードを書く
  • 公式ドキュメントは見ても良い
  • サンプル / ブログの類は見ない
  • 速く完成させようと思わない

公式ドキュメントやソースコードを読む前にしておくと良いこと

Yodaka

理解を早めたり正確に理解したりするためにもポイントがあります。

  • 読む前に読む目的を決めておく
    →時間を無駄にしない
  • 読む前に、それが何をするものなのかを理解しておく
    →外部仕様の正確な理解をして読み込むためのガイドラインを自分の中に作っておく

まとめ

根本から理解することは即効性のある内容ではありません。

しかし、プログラミングそのものを深く理解するために長期にわたって非常に重要なことです。

「早く理解したい」と焦る気持ちが理解そのものを妨げてしまうこともあることに気がつきました。

Yodaka

今後は、1回のエラーから学べることを増やして開発効率を高めていきます。

【宿題】

  • 2時間以上のまとまった時間を作る
  • ドキュメントやコードを1行ずつゆっくり読む

-Bot