技術系

公式ドキュメントの重要性【ライブラリを使うときはドキュメントが重要!】

どうも。ひろです。

アプリ開発や勉強の一環でライブラリを使用すると思いますが、その際ライブラリの公式ドキュメントを読むことがかなり重要になってきます。

公式ドキュメントを読むと以下のことがわかります。

  • メソッドの使い方、構成
  • メソッドの動作
  • デバッグ時のメソッドでのエラー対処法

公式ドキュメントを読む重要性について解説していきます。

公式ドキュメントからサンプルを持ってきて検証する

ブログ記事などで実際にライブラリのメソッドを使用しているコードを流用して活用している方が多いのではないでしょうか?

もちろんその方法も良いと思います!ですがその場合はもしライブラリのエラーとかが出てしまったときにエラーを消す作業に時間がかなりかかってしまいます。

そういったことがないようにドキュメントに使い方のサンプルがあると思うのでそちらを一度使って動作検証をしてみましょう。

サンプルが基本的なことしかしていないというのであれば他の方の記事を参考に応用して活用していくことでバグにつながりにくくなります。

公式ドキュメントにサンプルがないという場合もあると思いますのでその場合はQiitaなどで、できるだけシンプルなサンプルコードを探しましょう。

どのような構成になっているか把握できる

公式ドキュメントにはメソッドの構成がどのようになっているか書かれていることが多いです。

例えばこのメソッドにこの値を渡すと内部で〜の処理がされて戻り値として〜を返しています。のような文言が書かれていると思います。

また使用するときの制限事項なども書かれていることが多いです。

メソッドから内部で違うメソッドを呼び出している場合はドキュメントを見ないと構成がわからないと思います。

僕が見たことがあるメソッドは2つのメソッドを1つにまとめただけのメソッドがありました。

以前は公式ドキュメントなんか読むのは勘弁という思いでしたので、読まずに実際にそのメソッドを使って実装しました。

デバッグで動きを確認しようと思って動作確認をしていたらライブラリのメソッドを使用している処理で止まっていることがわかりました。

結果的に原因は2つのメソッドを1つにまとめていて、2つのうち1つが結果が帰ってくるまで待ち状態というメソッドでどこか違うところで結果を受け取ってしまいずっと止まっているというエラーでした。

このエラーはメソッド1つではなく、細分化した2つのメソッドで実装することで対応できました。

このエラーが解決できたのは公式ドキュメントの使用しているメソッドについての部分を読み込んだから特定できたエラーになります。

公式ドキュメントには2つのメソッドを1つにまとめているということが記載されていて実際に構成されているメソッドについてもリンクが貼られていました。

このようにドキュメントを読むことで複数メソッドからなるメソッドを読み解くことができます。

公式ドキュメントからエラーを解消

原因不明のバグが見つかったらまず動的解析を行うと思います。

動的解析とは実際に動作をさせながらどこの処理が動いているか把握する解析方法です。具体的にはデバッグ機能を使って解析することが多いと思います。

どの処理で不具合が起きているか解析している途中でライブラリを使用した実装部分で止まっていたとしたらそのメソッドの先で何かが起こっているということがわかります。

実際にメソッドの先を辿れるライブラリもあると思いますが辿れないメソッドの場合はどうするのか?

そうです。何回も登場していますが公式ドキュメントを頼りましょう。

まずは公式ドキュメントの使用しているメソッドについて知識をつける必要があります。どのような動きをしてどのような期待値を返すかドキュメントに明確に記載しているはずなので頑張って読み解いていきましょう。

それでもわからないという場合は他の方で同じようなバグが出てる人がいないか検索する必要があります。

初めから同じような現象が起きてる人の記事を見た方が早いとかもしれませんが、その方の記事には解決方法しか書いてなかった場合何が原因でどういったことをしたら解決できるということを認識していないので、

同じような現象が起こったときに対応できなくなってしまいます。

ライブラリのメソッドでバグが発生した場合は初めに公式ドキュメントを読んでみてください。

公式ドキュメントを読むことの重要性のまとめ

ライブラリを使用する際に公式のドキュメントを読む重要性についてのまとめとして以下のようになります。

  • シンプルなサンプルがあり検証しやすい
  • メソッドの構成を理解できる為、使用するときに懸念事項など考慮することができる
  • エラー、バグの解消につながることがある

プログラミング始めたての頃は公式ドキュメントなんて読む気になれん!と思う方も多いかと思います。

僕も実際そうでしたが、公式ドキュメントは情報の宝庫だということがわかり使用するときにどのような値を渡すと期待値としてどのような値が返ってくるべきということを認識した上で使用するようにしています。

そうするとでやってはいけない組み合わせなどがあった場合はドキュメントを読んだ時点で大体把握することができるので結果的にバグが出にくい実装になると思います。

ここまで読んでくださりありがとうございました。

合わせて読みたい記事

 

2020/9/27

効率よくプログラミング学習を進める方法をご紹介!

どうも。 ガジェット好き組み込みエンジニアのひろです。 プログラミング初学者の方で以下のような悩みを抱えている方はいませんか? 何をどのように進めていいのかわからない 未経験でプログラミングの勉強を始めたけど効率の良い学習方法がわからない。 オリジナル制作物を作る際の進め方がわからない この記事を読むことによって以下のことについて知ることができます。 プログラミングの勉強の仕方 学習効率の上げ方 オリジナル制作物を作る際の開発効率の上げ方 一番初めに記載しましたが、僕は現役で組み込みエンジニアをしています ...

ReadMore

2020/8/22

駆け出しエンジニアがスキルアップする方法3選ご紹介!

どうも。 ガジェット好き組み込みエンジニアのひろです。 今回の記事では僕がスキルアップするために実施してきたおすすめの方法3つご紹介します。 ご紹介する方法を1年間コツコツやっていた事でコード解析、実装力がある程度ついてきたと思います。 具体的にやってきたことは以下になります。 毎日Qiitaのトレンド記事を読む 隙間時間さえあればGitHubでのコード解析 テック系のニュース記事を読み漁る 簡単に僕の実績をご紹介します。 2019年の4月に新卒でIT企業に入社 プログラミング経験はあったが、3回程挫折 ...

ReadMore

2020/8/16

上手にスイッチをオンに切り替える5つの方法 これで仕事もプライベートも充実間違えなし!

どうも。ガジェット好き組み込みエンジニアのひろです。 皆さんはオンとオフの切り替えはしっかりと出来ているでしょうか? オンとオフの切り替えができていないとダラダラ仕事をやってしまうことになります。 この記事ではオンとオフの切り替える5つの方法をご紹介します。 今回は以下について記事にします。 時間を区切ってオン・オフをはっきりさせる。 どうしてもスイッチが入らない時は気分転換する 寝る前か起きてすぐタスク出しを行う 仕事後にプライベートの予定を入れておく 夜いろいろ考えてしまう場合は日記を書く 目次 1 ...

ReadMore

2020/6/18

作業の手戻りを少なくするコツを掴んで多くの作業時間を確保する方法

どうも。ガジェット好き組み込みエンジニアのひろです。 皆さんは作業などをしている時に手戻りは発生してますか? 僕はよく現場で手戻りが発生して時間を無駄にしてしまっています。 ですが、ある事をやりはじめたことによって無駄な時間を減らす事ができました。 この記事を読むことで得られることは以下になります。 手戻りの時間を減らす方法 自分の行動を意識的に分析できる 無駄な時間が減ることで自由な時間を増やせる   目次 1 無駄な時間とは? 1.1 無駄な時間をできるだけなくすにはどうすれば良い? 2 手 ...

ReadMore

2020/6/3

フリーランスの案件の取り方 人との関わり方で営業楽に?

どうも。ガジェット好き組み込みエンジニアのひろです。 最近は年内にフリーランスなるという目標に向かって頑張っています。 フリーランスに憧れるけど案件とかどう取るの?と思ったことはありませんか? 僕も案件を頂けるようになってきたのですが、お客さんから声をかけていただくことが多いです。 Web制作の案件で約25万程の案件をいただく事ができています。 なぜそういったことがあるのかというと、 学生の頃から周りとの関わりを大切にしており友人が働いている会社でこういう人がいるということを話していただけているからです。 ...

ReadMore

2020/5/24

ドライブの目的地の決め方は?いつもと違うドライブを楽しもう!

どうも。ガジェット好き組み込みエンジニアのひろです。 皆さんはドライブはお好きでしょうか? 以前僕は週に2回以上ドライブしていました。 ドライブするとき目的地が決まっていなくて決めてからいくということはありませんか? それも良い方法ですが、今回は目的地が決まっていなくても楽しめるドライブの方法を紹介します! 地元でドライブしても知らなかった発見が多いようなドライブの方法なので是非試していただきたいです! 具体的に以下の3種類について紹介します。 右折・左折限定ドライブ 右側の席 vs 左側の席 ドライバー ...

ReadMore

2020/5/16

初対面でも雑談ができる?簡単なコツさえ掴めばだれてもできる!

どうも。ガジェット好き組み込みエンジニアのひろです。 皆さんは初対面の方と雑談するのは得意でしょうか? 僕はあまり得意ではありません。 ですがちょっとしたコツを掴むことで長い時間雑談することができるようになりました。 このツイートでコツを簡単に説明しましたが詳しく解説します! / 初対面の人と話すときはその人の好きなもの、得意なものを聞き出し深掘りして行こう❗️ \ 僕は初対面の人と会った時は、その人が好きな事を聞き出します! その話について小さなことでも気になった事は質問することで相手は自分の好き事を話 ...

ReadMore

2020/5/9

Tkinterを使ったGUIアプリの作り方【第5回】

どうも。ガジェット好き組み込みエンジニアのひろです。 このシリーズは最終的に実際に記事に出てきた技術を駆使してGUIアプリを作るようなシリーズになっています 今回実装する機能はプルダウンの表示についてです。 これまでの記事を読んでいない方は読んでいただけると幸いです。 ソースコードはこちらからどうぞ! 第1回 基本的な画面表示の仕方 Tkinterを使ったGUIアプリの作り方【第1回】 第2回 ラベル・ボタン表示 Tkinterを使ったGUIアプリの作り方【第2回】 第3回 ボタン処理 Tkinterを使 ...

ReadMore

2020/4/26

オンライン作業会を開催してモチベーションの維持につなげよう!

どうも。ガジェット好き組み込みエンジニアのひろです。 皆さんはプログラミングやブログを書く際のモチベーションの維持はできてますか? 外出自粛になりカフェも利用できない期間の中で自宅で作業をしているとモチベーションの維持が難しいなと感じたことはないでしょうか? 僕はモチベーションの維持のためにオンライン作業会を身内で開いています。 オンライン作業会でモチベーションを維持するために以下のことを意識しています。 ・作業内容と実績を周りに共有する ・雑談で近況報告を行い情報共有を行う ・ビデオをオンにする 今回は ...

ReadMore

2020/4/20

リモートワークで成果を出すコツ 集中するには切り替えが重要!

どうも。ガジェット好き組み込みエンジニアのひろです。 最近リモートワークという言葉をよく耳にしますよね? 普段から自宅で仕事をする習慣がないと集中できずに生産性が落ちてしまいます。 今回の記事では生産性向上や集中力を維持するためのコツをご紹介します。 一気に全部取り入れるのではなく一つずつ取り入れていきましょう! 目次 1 リモートワーク時のオンとオフの切替 1.1 ポモドーロ・テクニックを活用する 1.2 作業が進まなくなったら周りとコミュニケーションをする 2 環境を整える 2.1 机の上の整理 2. ...

ReadMore

-技術系
-, , , ,

Copyright© 日常で感じたことブログ , 2020 All Rights Reserved Powered by AFFINGER5.