MOの気になることを適当に伝えるブログ

moNote

Python

Python の コメント

投稿日:

プログラム言語を勉強する時は まずコメントから!

# で コメント

# コメント

print("コメントについて")  # コメント

"文字列はコメントとして成り立つ"

'文字列はシングルクォーテーションでもOK'

使うことは 無いと思いますが  コードの中で 使わない文字列を指定しても 問題無いようです。 結果、 コメントになります。
 

ブロックコメントの機能は無い

でも、ブロックコメントしたい時には 以前の記事を

コーディング規約 - PEP8

コメントとは違いますが  Pythonではソースコードのスタイルに一貫性を持たせ読みやすいコードにするため「PEP8」と言われるコーディング規約が発表されています。

PEP8 日本語訳
https://pep8-ja.readthedocs.io/ja/latest/

命名規約の部分を 少し 箇条書きにすると

  • パッケージ名:小文字で、短い名前。
  • モジュール名:小文字で、必要ならアンダースコアーを利用
  • クラス名:単語の先頭を大文字でつなげる
  • 関数名や変数名:小文字のみ、単語間はアンダースコアを用いる
  • 定数名:大文字で、単語間はアンダースコアを用いる

などです。

ただし、 PEP8 には はじめの方に 次のようき記載されています。

一貫性にこだわりすぎるのは、狭い心の現れである

Guido の重要な洞察のひとつに、コードは書くよりも読まれることの方が多い、というものがあります。この文書で示すガイドラインの目的は、コードを読みやすくするとともに、Pythonで書かれた幅広いコードのスタイルを一貫させることです。PEP 20 にもあるように "可読性重要" です。

スタイルガイドは一貫性に関するものです。このスタイルガイドに合わせることは重要ですが、プロジェクトの中で一貫性を保つことはもっと重要です。一番重要なのは、特定のモジュールや関数の中で一貫性を保つことです。

この手の コードスタイルは 少し気に掛けて 少しずつ 慣れればいいと思います。
Python は手軽に書けて動かせるのが いい点だと 思います。後の為に コーディングに注意することは 必要ですが、気にしすぎて プログラムを書くことの楽しさを忘れてしまっては 本末転倒ですから。。。

でも、あまりに汚いコードでの アドバイスを頼まれると。。。
やる気が 出ないのは 本当です(汗

-Python
-,

Copyright© moNote , 2020 All Rights Reserved Powered by STINGER.