Pythonのコメントと変数について

Pythonでは、コードの可読性を高めるためにコメントを活用します。コメントは、コードがどのように動作するかを説明するためのメモで、実際にコードを動かすコンパイラやインタープリタからは無視されます。

Pythonのコメントの種類

Pythonでは、# 記号で始まる行がコメントとして宣言されます。コメントを宣言する方法には、インラインコメントとブロックコメントの2つがあります。

インラインコメント

インラインコメントは変数や簡単な操作方法を説明する短い文で、コードと同じ行に記述します。

border = x + 10  # Make offset of 10px

ブロックコメント

ブロックコメントは、コード内の複雑なロジックの記述に使用されます。Pythonのブロックコメントはインラインコメントと同様の記法ですが、コードとは別の行に記述される点で異なります。

# Get a list of names in a sequence from the csv file
with open('new-top-firstNames.csv') as f:
    file_csv = csv.reader(f)

Pythonのdocstring

Pythonのdocstringは、関数やクラスの使い方を説明する複数行のコメントです。高品質なdocstringsを作成することで、コードのドキュメントを改善できます。

def get_person(name, age, d=False):
    """
    Returns a namedtuple("name", "age") object.
    Also returns dict('name', 'age') if arg `d` is True

    Arguments:
    name  – first name, must be string
    age   – age of person, must be int
    d     – to return Person as `dict` (default=False)
    """
    p = Person(name, age)
    if d:
        return p._asdict()
    return p

以上、Pythonのコメントと変数についての基本的な情報を提供しました。これらの知識を活用して、Pythonコードの可読性を向上させ、効率的なコーディングを実現しましょう。