コメント（注釈）を書くクセを付けると、あとで混乱しない

こんにちは。渡辺です。

今日は、コンピュータには何もさせないけど、重要なテーマです。

プログラムの中には、どんな処理をしているのかメモできる「注釈文」（コメント）を書くことができます。

コンピュータは注釈文に書かれていることは無視するので、動作には何の影響もありません。

人は昔の自分も忘れてしまう

大きな開発プロジェクトのように何人もの人間でプログラムを作るときはもちろん、自分一人の場合でも、少しでも複雑なプログラムを書くと、後から見直した時に、どういう意図で作ったのか分からなくなってしまいます。

そのため、プログラムを書くときは、自分がどう考えて、このプログラムにどういう処理をさせているのかをプログラム内にメモしておくようにします。

これがコメント（注釈文）です。

Pythonのコメント文の書き方は簡単で、行の最初に # を書くと、その行のそれ以降の記述は全てコンピュータからは無視されます。

アプリでも変な動作を直したり、新しい機能を追加したり、バージョンアップすることがあります。

その時、自分や他のプログラマーが書いたコードを読み返しながら、変な動作の原因となる誤り（バグ）を探し出して修正したり、ある処理にコードを追加して、新しい機能が動作するようにするわけです。

まるで母国語のようにプログラムを読める凄腕職人プログラマーもたまにいます。

でも、我々専門家ではないけど、ちょっと便利なツールをゲットしたい、なんて人は、自分がコンピュータに何をやらせようとするのかを明確にして、後からプログラムを修正するときのためにも、重要な処理をやらせる前、プログラムの区切りなどに、コメントを入れる習慣を付けるのがいいです。

プロの開発者であれば、別に設計書を作って、どういう機能か、プログラムのコードをどう作成するか、と文書にするのが標準的なやり方ですが、我々が目標とする、ちょっと便利なツールを作るくらいなら、プログラムの先頭などにコメントでツールの機能や利用目的、作成や修正の日付を書いておく、なんて使い方で十分です。

編集人が作った投資分析プログラムの先頭部分を、事例として載せておきます。

少し長いプログラムを書く場合には、別途ワープロで機能や処理の流れを文章で書いてみることもありますし、そこまでやらない場合は、上記のようにプログラムの中に注釈文として日本語で書いて、それを元にPythonのコードに置き換える、なんて作り方もします。

ちなみに、プロの書いたプログラムでは、コードの3割とか、多い人だと半分近くが注釈だという人さえいます。

Pythonのプログラム中に、そのプログラムにどんな機能があるのか、どういう作りなのか、何をいつ修正したかなどをメモしておくようにする。これを注釈（コメント）という。

行頭を # で始めると、その行は注釈となってコンピュータからは無視される。わかりやすいプログラムを書くためには、注釈を積極的に使うとよい。