コメントで意図を残す

コメントはコードから推測できない理由や制約を記録する場所です。コードの動作を逐語的に繰り返すより、単位、通信仕様の根拠、安全上の前提などを書きます。

コメントはコードから推測できない理由や制約を記録する場所です。コードの動作を逐語的に繰り返すより、単位、通信仕様の根拠、安全上の前提などを書きます。このページでは、構文だけでなく、入力の検証と再現可能な確認方法も扱います。

考え方と使いどころ

空白や出力形式もインターフェースの一部です。ログを機械で読む場合は、表記を安定させます。

手元のPython環境に貼り付ける前に、使用しているPythonの版と対象ライブラリの対応を確認してください。

device = "sensor-A"
ready = True

if ready:
    print(f"{device}: ready")  # 状態を記録する

ビットマスク処理に、対象プロトコルの仕様に基づく理由をコメントしてください。