※この記事は、エンジニア志望の大学生が勉強のアウトプットとして書きました。コメントを各際に、他にこんなことを気を付けているなどあればご指摘いただけると幸いです。
Pythonでは、1行や複数行にわたってコメントを書くことができる。
#ここにコメントを書く
"""複数行にわたって
コメントを
書くことができる"""
- 複数行の場合はトリプルクォートで書いた方が良し。
- コメントは普通、コードの末尾ではなく単独の行に記述すると良し。
- フレーズや単語ではなく、意味が通る文章として記述すべし。
- コメントをするコードと同じレベルでインデントすべし。
- pep8の横文字制限80文字に従うこと。
インラインコメントは変数の目的や意味を記述すべし！
⇒変数のデータ型は記述しない（代入文を見ればわかる）
human_Weight = 65 #単位はキログラム
human_height = 175 #単位はセンチメートル
コメントはコードの動作ではなく、背景を明かにすべし！
誤り#65を175の2乗で割っている
正 #BMIを計算している
print(65/(175)*2)
要約コメントを各コードの「段落」の頭に入れるべし！
他のプログラマーがざっと読んだときに大まかにわかるようにすべし。
⇒コードのまとまりごとに要約コメントがあればソースコードを流し読みしたとき、大まかに把握できる。
要約コメントが所々にあると全体の構成がわかりやすい。
# AとBの最大公約数を求める関数
def GCD(A, B):
answer = 0
for i in range(1, min(A, B) + 1):
if A % i == 0 and B % i == 0:
answer = i
return answer
A, B = map(int, input().split())
print(GCD(A, B))
型ヒントをつけよう！
pythonは動的型付けのプログラミング言語である。
変数や戻り値のデータ型を宣言することなく、扱える
※他言語では、静的型付け（データ型宣言が必要）もある。
少ないコードで済むというメリットもあるが、データ型を間違えたことによるバグを防げない。
静的型付けはデータ型が違うと警告を発してくれる。
num: int = 23
def main(number: int) -> str
のように型ヒントをつけることで、静的型付けの安全面と動的型付けの柔軟性を持った漸近的型付けが可能。
型ヒントは、指定したデータ型を強制するものではないが、mypyを使うことでプログラム実行前に解析ができる。
⇒mypyをインストール後、ターミナルにて
python3 -m mypy ファイル名
で実行するか、各エディターで機能を有効にしてバックグラウンドで実行させる。