見出し画像

意図を理解してもらうためのプログラムの書き方

わかりやすいプログラムを書くように心がけていますか?
わかりにくいプログラムばかり書いていると他人に引き継いだ時に悪影響になります。

意図を理解してもらうためにもわかりやすいプログラムを書くように心がけましょう。

こんにちは、みやびのです。

SIerとして7年、Webエンジニアとして3年やっていました。

今回は、プログラムの意図を伝えるための具体的な方法について紹介します。

先日こちらのツイートをしました。

https://twitter.com/miyabikno/status/1142059215264993280

このツイートの内容を具体的に説明します。

意図を理解してもらうための4つのポイント

意図を理解してもらうポイントは以下の4つです。

・ポイント1:変数名や関数名はわかりやすい名前にする
・ポイント2:わかりやすい処理にしよう
・ポイント3:コメントを入れる
・ポイント4:ドキュメントを残す

順番に説明します。

ポイント1:変数名や関数名はわかりやすい名前にする
変数名が「a」や「x」とかだと何のための変数かわかりにくいです。
同様に関数名が「test()」とか適当な名前だと何のために呼ぶ関数かわからなくなります。

例えば
身長と体重に関する変数の場合は、
・身長:height
・体重:weight
などわかりやすい名前にしましょう。

同様に「加算する関数」なら「add()」など何をする関数かわかりやすい名前にします。

宣言にコメントを入れる方法もありますが、できるだけコメントを使わずに処理が連想できるのが望ましいです。

変数や関数について初心者がまず覚えることについてはこちらの記事にまとめているので参考にしてください。

Python初心者が理解しておくべき変数の3つの役割

Python初心者が理解しておくべき関数の3つの役割

ポイント2:わかりやすい処理にしよう
長文のプログラムや処理がぐちゃぐちゃなプログラムはわかりにくく理解に時間がかかります。
プログラムを最適化してわかりやすい処理を目指しましょう。

わかりやすい処理をする方法は以下の方法があります。

・何度も使う処理は関数化して繰り返しを削除する
・インデントを整える
・定期的にリファクターする

ポイント3:コメントを入れる
プログラムで表現仕切れない部分はコメントを入れてコードの意図を明確にしましょう。

コメントは入れ過ぎないことが大切です。
逆に読みづらくなります。

コードを見ればざっくりとでも処理が理解できるものについてはコメントはいりません。
処理を勘違いしやすい箇所や意図が伝わりにくい箇所に入れるようにしましょう。

ポイント4:ドキュメントを残す
プログラムの処理や仕様についてドキュメントを残すことも大切です。
製品全体のポリシーや考え方などを書いておきましょう。

明日の自分も他人と思ってプログラムを書こう

・自分しか見ないプログラムだからわかりにくくても良い
と思うかもしれません。

でもわかりやすさを求めるのは他人のためだけではありません。
明日の自分も他人と思いましょう。

次の日になれば前の日の記憶なんて忘れているかもしれません。
わかりやすいプログラムを明日に届けましょう。

そして明日だけならある程度は覚えているかもしれないですが、

1週間後は?
1ヶ月後は?

さらに1年後だったら?

いつまた触ることになるかなんてわかりません。
未来の自分を苦しませないためにもわかりやすいプログラムを追求しましょう。

まとめ:明日コードを書く人を救おう

わかりやすいプログラムを書くように心がけることが大切です。
何も考えずにプログラムを書くと意図の伝わりにくいものになります。

処理や変数・関数はできるだけわかりやすいものにしてコードを読むだけでもある程度の処理は理解できるようにしましょう。
理解の補助としてコメントやドキュメントも活用しましょう。

わかりやすいプログラムを書くことは他人に自分のプログラムの意図を理解してもらうためには非常に大切なことです。

明日の自分もまた他人。
未来に自分のためにも日々わかりやすいプログラムの追求をしましょう。

関連記事>>プログラミングのスキルアップ方法まとめ

note一覧


みやびのnote一覧


この記事が気に入ったら、サポートをしてみませんか?気軽にクリエイターを支援できます。

4
プログラミング系ブロガーです。 エンジニアやプログラミング系のノートをメインに書いています。 ブログ:https://se.miyabikno-jobs.com/
コメントを投稿するには、 ログイン または 会員登録 をする必要があります。