PyQオフィシャルブログ

Pythonのオンライン学習プラットフォームPyQのオフィシャルブログです

公式ドキュメントの用語が理解できません。調べながら全て読んだ方がいいですか?

f:id:nana_yu:20190415131313p:plain

PyQサポートのsusumuisです。 今日は、学習サポートに寄せられた公式ドキュメントについての質問にお答えします。

質問はPythonの学習についてのものですが、 言語や技術を問わず、プログラミング学習者皆さんに通じる内容だと思います。 是非参考にしてみてください。

質問

PyQの学習サポートで質問をした時に、Pythonなどの公式ドキュメントへのリンクをよく貼ってもらうのですが、用語が難しくて読んでも理解ができません。 わからなくても、言葉を調べながらでも読んでいったほうがいいのでしょうか? それとも、知識がある程度増えてから読み始めるのがいいのでしょうか?

回答

公式ドキュメントを読むことは大切です。 Python初学者の方も、早い段階から公式ドキュメントを読む習慣を身につけるべきだと思います。

確かに、公式ドキュメントは英語で書かれたものを翻訳したものですので、読みづらいです。 また、高い前提知識を要求していることも否めません。 分からない言葉があった時、それらを無理やり調べる必要はありません。 まずは、なんとなくでも「わかる」部分が増えていけば良いと思います。

公式ドキュメントを読むべき理由

1. 公式ドキュメントにかかれていることが正であること

公式ドキュメントには常に「正しいこと」が書かれています。 開発者の「意図」とも言えます。

一方 https://www.python.org/ からダウンロードできる、いわゆる CPython と呼ばれる実行プログラムはその意図を実現した「実装」に過ぎません。

もし、ドキュメントに書かれている通りに実装が動かなかったとしたら、正しいのはドキュメントなので、CPythonの将来のバージョンで修正されるでしょう。

そのため、公式ドキュメントを読まず「こう動いたから」だけでプログラミングをしてしまうと、CPythonのバグでたまたまそう動いていたものが、将来のバージョンで修正されてしまい、プログラムが動かなくなってしまうことがありえます。

私は質問に回答する時、必ずドキュメントで裏を取ってから回答するように心がけています。

2. 公式ドキュメントは情報が網羅されていること

Webで検索すると、ブログなどで多くの人がサンプルコードや解説記事を公開しています。 そうした情報は公式ドキュメントよりも読みやすいため、私もよく参考にします。 しかし、このような情報は執筆した人の課題に対応するために必要な範囲に限られています。

一方公式ドキュメントは網羅的です。 例として、print関数の公式ドキュメントを見てみましょう。

https://docs.python.org/ja/3/library/functions.html#print

普段何気なく使っているprint関数も、実は sepend, file, flush というオプションが指定できることがわかります。 このように公式ドキュメントを読むことで、知らなかった便利な機能が発見できることがあります。

私は普段使っている機能でも時々公式ドキュメントを読むことで、知らなかった機能を知るようにしています。

まずは動かしてみることも大切です

先の項目で、わからない言葉を無理に調べる必要がないと述べました。 ドキュメントの全ての用語を理解するよりは、 実際にドキュメントに書いてある項目を使ったサンプルプログラムを書き、 動かしてみて理解する方が良いでしょう。

実際にコードを動かすことで身についていき、 公式ドキュメントの内容も、徐々に理解できる事柄が増えてくるでしょう。

今回は、PyQのスタンダードプランで活用できる学習サポートで、参考情報として提示される公式ドキュメントについての質問でした。

PyQではプロの所作を学ぶことを目的にしています。 プロにとって、ドキュメントを読むことは必須であるため、 PyQの受講生の方には、自らドキュメントを読んで調べられるようになって欲しいと考えています。

そのため、PyQ学習サポートでは、公式ドキュメントの該当項目を 質問への回答と合わせて積極的に提示しています。

docs.pyq.jp

Copyright ©2017-2018 BeProud Inc. All rights reserved.