triBlog

トリアナのブログ。

バックエンド
フロントエンド

ソースコードを書く上で重要なこと

たまには真面目に書きます
ライター画像
たなか

こんにちは。

今回はソースコードを書く上で重要視していることをお話します。

 

結論

読むだけで理解できるようなソースコードを書くこと

理由

①拡張性を保つため

②保守性を保つため

③属人化を防ぐため

※上記は全て人的リソースの削減に繋がります

方法

変数や関数などにわかりやすい名前をつける

その変数にどのようなデータが格納されているか、この関数はどのような処理を行うのか、

ということを、ソースコードを追わずに理解できるような名前をつけます。

より具体的な名前をつけると良いですが、長すぎるとわかりづらくなるためセンスが必要です。

ソースコードを読んでわかることはコメントに書かない

例えば、ガチャポンの仕組みを実装するプログラムがあるとして、

 

投入金額が200円の場合、景品を排出する

のコメント部は全く不要です。

なぜなら、ソースコードを読めばわかるからです。

コメントを書く必要性を感じた場合は、ソースコードを見直したほうが良いです。

仮に上記ソースコードにコメントを入れるとすると、

など、他者がソースコードを読む際に疑問に思うポイントを補う、などに利用するのが良いでしょう。

短いコードを書く

プログラムのソースコードは、書けば書くほどバグが生まれます。

つまり、ソースコードを書くことを極力少なくすれば、バグも少なくなります。

また、ソースコードの視認性を高めることにも繋がります。

これらを意識することで、保守性を保つことが可能です。

リーダブルコード

前述したような、ソースコードを書く上でのポイントは、当書籍で学ぶことができます。

駆け出しエンジニアのころ大変お世話になりました。今でもオフィスのデスクに置いており、たまに読みます。

現職プログラマさんや、これからプログラマを目指す社会人・学生の皆さん。

ぜひご一読を。

それでは。

 

 

WEBサイトなどのご相談はこちらからどうぞ

記事を書いた人

ライター画像
たなか バックエンドエンジニア

ゲームが好きです。1日10時間ゲームして生活したいです。

ライター画像
たなか バックエンドエンジニア

ゲームが好きです。1日10時間ゲームして生活したいです。

ページ上部へ