#10 Pythonで学ぶコメント規約の基本

コードの中に、実行はされないメモを残せる仕組みを「コメント」と呼びます。この記事では、Pythonにおけるコメントの書き方と、書く際の慣習について解説します。

コメントの書き方

Pythonでは#から行末までがコメントとして扱われます。

# これは年齢を表す変数
age = 20

複数行にわたるコメントには、3つの引用符('''または""")で囲む書き方もよく使われます。

"""
ここから先は入力チェックの処理
空文字や不正な形式を除外する
"""

docstringという独自の慣習

Pythonには「docstring」という、関数やクラスの説明を書くための特別なコメントの書き方があります。

def greet(name):
    """利用者に挨拶を表示する関数

    Args:
        name (str): 利用者の名前
    """
    print(f"こんにちは、{name}さん")

関数の直後に3つの引用符で書かれた文章は、その関数の説明として、他のツールからも読み取れる特別な扱いを受けます。help(greet)と入力すると、このdocstringの内容がそのまま表示されます。

TODOコメントで作業を残す

後で対応する必要がある箇所には、# TODO: 説明という形式でコメントを残す習慣が広く使われています。多くのエディタはTODOコメントを一覧表示してくれるため、実装途中の箇所を見失いにくくなります。

何を書くべきか

良いコメントは「何をしているか」ではなく「なぜそうしているか」を書くのが基本です。コードを読めば分かることを繰り返し書くのではなく、判断の理由や注意点を書くようにしましょう。

Pythonならではの注意点

docstringは書かなくてもエラーにはなりませんが、Pythonのコミュニティでは特に重視される慣習です。公開する関数やクラスには、最低限docstringを書いておくと、他の人が読んだときの理解のしやすさが大きく変わります。Args・Returnsのような書式にはいくつかの流派(Google形式、NumPy形式など)があるため、プロジェクトで統一されている形式を確認してから書き始めるとよいでしょう。

型ヒントとコメントの役割分担

比較的新しいPythonでは、型ヒントによって「どんな型を受け取るか」を表現できるため、コメントで型を説明する必要性は下がっています。

def add(a: int, b: int) -> int:
    """2つの整数を足す"""
    return a + b

型ヒントで「何を受け取るか」、docstringで「何をする関数か」、コメントで「なぜそうしたか」という役割分担を意識すると、情報が重複せず整理されたコードになります。

まとめ

Pythonのコメントは#が基本で、関数の説明にはdocstringを使うのがPythonらしい慣習です。型ヒントとの役割分担、TODOコメントの活用も含め、「なぜ」を書くことを意識しましょう。

本ページはプロモーションを含みます。

参考書籍(PR)

Pythonをもっと学びたい方には「スッキリわかるPython入門 第2版」がおすすめです。

PR

コードを書かずに自動化したい方へ

「学んだけど自分の作業に組み込む時間がない」という方向けに、ダブルクリックで動く Windows専用の自動化ツールをオーダーメイドで作成しています。気になる方は こちらをご覧ください。

コメント

コメントを投稿

このブログの人気の投稿

#25 Rustで学ぶAI API(ChatGPT等)の呼び出し方の基本

ChatGPTのようなAI(人工知能)の機能を自分のアプリに組み込みたいとき、多くの場合は「AI API」と呼ばれる仕組みを使います。APIとは「Application Programming Interface」の略です。簡単に言えば、「あるサービスの機能を、プログラムから呼び出せるようにした窓口」のことです。この記事では、Rustから外部のAI APIをHTTPリクエストで呼び出す基本的な流れを、初心者向けに解説します。 AI APIを呼び出すとはどういうことか ChatGPTを提供するOpenAI社などは、インターネット経由でAIに質問を送り、回答を受け取れる「AI API」を公開しています。これはWebブラウザで検索するときのように、決まった宛先(URL)にデータを送信し、返ってきた結果を受け取る仕組みです。この「データを送って結果を受け取る」通信方式を、HTTPリクエストと呼びます。Rustのプログラムからこの通信を行うことで、自分のアプリの中でAIに質問し、回答を取得できるようになります。 reqwestクレートを使う Rustには標準でHTTP通信の機能は含まれていません。そこで使うのが「クレート」と呼ばれる外部ライブラリです。クレートはPythonのライブラリやJavaScriptのパッケージに近いもので、 Cargo.toml というファイルに追記するだけで簡単に導入できます。HTTP通信でよく使われるのが reqwest というクレートです。 Cargo.toml に次のように追記します(バージョン番号は執筆時点の例なので、実際に使う際は最新版を確認してください)。 [dependencies] reqwest = { version = "0.11", features = ["json"] } tokio = { version = "1", features = ["full"] } serde_json = "1.0" ここで tokio という見慣れないクレートも一緒に入れています。これは「非同期処理」と呼ばれる、通信の待ち時間の間に他の処理を進められる仕組みを扱うためのものです。ネットワーク通信は結果が返ってくるまで時間...
続きを読む

#8 C++で学ぶ文字列操作の基本

C++の文字列操作は、`std::string`という型を使うのが現代的な基本の書き方です。この記事では、C++における文字列操作の基本と、注意しておきたい落とし穴を解説します。 文字列を連結する std::string greeting = "こんにちは、" + name + "さん"; `std::string`同士であれば、`+`を使った連結がそのまま使えます。既存の文字列に追加する場合は`+=`や`append`メソッドも使えます。 greeting += "。よろしくお願いします。"; よく使う文字列操作 name.length() 文字数を調べる(バイト数であることに注意、後述) name.substr(0, 3) 一部分を取り出す(開始位置と長さを指定) name.find("A") 特定の文字の位置を探す(見つからなければ`std::string::npos`) name.replace(0, 2, "XX") 一部分を置き換える 文字列を数値に変換する 文字列を数値に変換したい場合は`std::stoi`(整数)や`std::stod`(小数)、逆に数値を文字列にしたい場合は`std::to_string`を使います。 int num = std::stoi("123"); std::string s = std::to_string(456); 文字列を分割する C++の標準ライブラリには、他言語の`split`のような文字列分割の関数が長らく用意されていませんでした。`std::stringstream`を使うのが伝統的な方法です。 #include <sstream> std::stringstream ss("a,b,c"); std::string item; while (std::getline(ss, item, ',')) { std::cout << item << std::endl; } C++ならではの注意点 C++には、古くからある`char`の配列を...
続きを読む

#16 TypeScriptで学ぶ辞書型(マップ)の基本

TypeScriptの辞書に相当する仕組みは、JavaScriptと同じですが、キーと値の型をあらかじめ決めておけるのが特徴です。この記事では、TypeScriptにおける辞書の扱い方と、用途別の型の選び方を解説します。 型付きのオブジェクト interface Person { name: string; age: number; } const person: Person = { name: "太郎", age: 20 }; キーの型が決まっていない辞書 キーの名前が事前に決まっていない辞書のような使い方をしたい場合は、次のように書きます。 const scores: { [key: string]: number } = {}; scores["太郎"] = 90; 同じ意味を Record というユーティリティ型で簡潔に書くこともできます。 const scores: Record = {}; Mapを使う場合 const person = new Map (); person.set("name", "太郎"); console.log(person.get("name")); Map<string, string> のように、キーと値それぞれの型を指定できます。 Object と違い、キーの数を person.size で正確に取得できる、キーの型を文字列以外にもできるといった利点があります。 値が存在しないかもしれない場合 キーが実在するとは限らない辞書の場合、値の型に | undefined を含めておくと、より正確な型になります。 const scores: { [key: string]: number | undefined } = {}; const value = scores["三郎"]; // number | undefined 型 こうしておくと、存在しないキーへのアクセスがコンパイル時に見過ごされにくくなります。 存在しないキーへのアクセスを防ぐ tsconfig.json で noUncheckedIndexedAccess を有効にす...
続きを読む