【Python入門 #3】読みやすいプログラムを目指そう!(コメント文とスタイルガイド)

スポンサーリンク

SYSARTアプリ開発部のワクワクUMA博士です。

GW中は長崎県の雲仙地獄めぐりにいってきました。温泉地への戻り際、雲仙温泉神社というところがあり おみくじを引いたところなんと大吉。「これ天啓では?」と宝くじを買ってみました。 さてどうなるでしょうか。こんどこそ億万長者になっていることでしょう!

さて前回は簡単なプログラムの作成とPyファイルの作り方を勉強しましたね(前回リンク)。
今回は実践編ですが、少し基本的なところで”コメント文”や“読みやすいコードの書き方”やといったプログラムを整理しながら作る方法を勉強したいと思います。

こうゆうの覚えておくと、後々の学習効率の向上や効率化につながっていくので割と大事ですよ!(と個人的には思ってます)


今回の記事で紹介するのは、次の通りです。

スポンサーリンク

コメント文ってなに?

(1)試しに書いて実行してみよう!

① 前回記事で作成したprinttest01.pyを利用してみます。


② ファイルをコピーしてファイル名を「Study03_test01.py」にしてから編集してみましょう。


③ 赤文字部分のようにプログラムコードの中に「#」から始める文字列を追記してみます。

#このプログラムはUMA博士を気持ちよーくする言葉をつづります。
print("Dr. UMA is") # endを指定しない場合は終端文字は改行となります。
print(" very ",end = "") # endを空白に指定したため次のprint出力は改行されず表示されます。
print(" Handsome ", end = "!!!")
print(" and Sexy.") # Oh...セクシー...!!!


④ pyファイルを忘れずに保存してから、実行してみましょう。


⑤ どうでしょうか。結果は前回の出力結果と変わらないはずです。
  コメント文とは、インタプリタが無視する、いわゆる“メモ書き”となります。


(2)コメント文ってどうゆう書式?

# ” コメント ”

「#」で始まりその行末までがコメントの範囲になります。


(3)どうゆうときに使うの?

主に我々プログラムを作る人たちの為の機能です。

例えば他の人にプログラムコードを渡すときや、あとから自分がコードを見たときに
「ここはこうゆう意味ですよ」と情報を残した方がスムーズに意思伝達できますよね。

他にも「ここは後でこうゆう処理をいれたい」「ここはテスト用にいれた処理だから覚えておこう」といった一時的な覚書きでも良く使う用途です。

ただ、人によりけりなんでしょうけどコメントってついつい書きすぎたりするんですよね。 私なんかはやたらコメントが多く書いて後から見たとき逆に分かりづらくなってたり、コメント自体の 修正なんかで無駄に開発時間を使ってしまう反省するケースがあったりします…

コメントをしっかりかくなら、ある程度開発してから整理して書くのがおススメかなと。

※また本記事とはあまり関係ないですが、とても気になる記事をご紹介。
どうも変更履歴なんかを頻繁にコメントとして残すのはレガシープログラマみたいです。

昔先輩方に教わったようなことも時代の変化ととともに変わっていくんですね。時代においていかれないようにせねば。とレガシーなプログラマは思うでした。


コードを見やすく書くために(スタイルガイドPEP8)

(1)あると便利な共通認識。それがスタイルガイド!

プログラムを書く上で、人それぞれ書き方があると、他の人が見たとき見にくかったり後から自分で見返したときに“やっぱりこの書き方にする!”と変な戻り作業がでるときがあります。

そんな時に共通のルールがあると便利だと思いませんか?
Pythonではスタイルガイド「PEP8」というのが用意されています。

(2)必ず守らないといけないの?

守らなくてもプログラムは動作するので強制ではないです。ただ開発が進むほどに“前書いたときはどう書いてたっけ?”と余計な悩みを生みがちです。

例えば先ほどのコメント文一つとっても以下のように「#」の前後に空白を入れるかどうかでも、ずれがでてしまいます。後々みたときこうゆうの気になるんです。

“print(“test1”) #コメント”
“print(“test2)    # コメント”

なのであらかじめ“これに従う!”とルールを決めることで、途中で余計な悩みに右往左往しなくて済むという利点があるのです。

じゃあなぜ強制されていないのかというと柔軟性の話なんですね。ルールに従わせる必要がないような場合やできない場合のために許容はされています。。ルール準拠は大事だけど柔軟性も許容できる器ももつ。人間的にも結構大事なことですよね。

(3)どうゆうルールがあるの?

日本語ドキュメントは以下URLを参照です。

はじめに — pep8-ja 1.0 ドキュメント

ただ最初からすべてを読み込むのも大変なので、次の章よりルールに準拠しているかチェックしてくれる便利なツールのご紹介と、代表的なガイドルールをご紹介します。


スタイルガイドのチェックをしてくれるツール!

次のページよりご紹介します!(クリックで開きます)

スタイルガイドPEP8のルール例

次のページよりご紹介します!(クリックで開きます)

コメント

タイトルとURLをコピーしました