ソースコードに対する理解を補助するのが、適切なコメントだ。コメントを書くためにプログラマーが理解しておくべき原則を、実例とともに解説する。
プログラマーはソースコード内に、補助的なテキストを「コメント」として挿入可能だ。読みやすく、メンテナンスしやすいソースコードにするには「良いコメント」が欠かせない。具体的には、どのようなコメントが良いコメントなのか。
ソースコードの内容をそのまま繰り返すだけのコメントは、有益な情報をほとんど提供しない。良いコメントとは、読んだ人が「プログラム実行時に何が起こるのかを理解できる」コメントだ。
良いコメントの例を見てみよう。以下は、プログラミング言語「Python」の教材用に書かれたソースコードだ。取得した日付情報を、さまざまな形式の日時表現の文字列に変換する関数を定義している。
# プログラムが稼働するマシンの所在地の日付を取得する(タイムゾーンは考慮しない) # 注意:dateはプログラムの冒頭でインポート済み def stringdate(): today = date.today() date_list = str(today).split('-') # 「月-日-年」の形式で文字列を作成する date_string = date_list[1] + "-" + date_list[2] + "-" + date_list[0] return date_string
プログラムの概要は以下の通りだ。
このソースコード内にあるコメントは「ソースコードが『何をするか』ではなく、『何のためのものか』が分かるコメントを書く」という、良いコメントの原則を反映している。ここでのコメントの役割は、Pythonを学ぶプログラマーが、関数に対する理解を深めることだ。以下にコメントの詳細を示す。
次回は、これまでに説明した「良いコメント」の条件をまとめる。
米国TechTargetの豊富な記事の中から、開発のノウハウや技術知識など、ITエンジニアの問題解決に役立つ情報を厳選してお届けします。
Copyright © ITmedia, Inc. All Rights Reserved.
お知らせ
米国TechTarget Inc.とInforma Techデジタル事業が業務提携したことが発表されました。TechTargetジャパンは従来どおり、アイティメディア(株)が運営を継続します。これからも日本企業のIT選定に役立つ情報を提供してまいります。
生成AIの活用、意外と進んだマーケティング部門と進まない営業部門 どうして差が生じた?
HubSpot Japanが実施した「日本の営業に関する意識・実態調査2025」のポイントを、記者説...
Webサイト改善のゴール(KGI)と戦略(KPI)の決め方
連載第2回目となる今回は、Webサイト改善のためのゴール(KGI)と戦略(KPI)の設定方法...
メルマガをきっかけにした商品購入、B2B商材ではどれくらいの人が経験?
ラクスが「メルマガに関する調査レポート」を公表した。メルマガ経由のサービス購入や資...