創屋ぷれす

PIE原則

PIE原則について調べました。

PIE原則とは・・・
ざっくり言うと、読みやすいソースコードを書きましょう。
という原則です。

システムの開発をするうえでドキュメント等を用意しますが
このドキュメントの記述が間違っていたり、更新がされていなかったりすると
今、どういう風に動いているか?というのを知るためにはソースコードを見るしかないです。

バグ等が無ければ、ソースコードを書くのは1回でよく、見る時間と比べると
見る時間の方が圧倒的に多いことも理由の1つです。

そもそも読みやすさとは何なのか?というのは正直分からなかったりします。
調べたサイトではコメントを書く。と書かれていましたが
書いた本人はコメントが無くてもある程度分かったりするものです。
また、ドキュメントと同じでコメントが間違っていたり、更新されていなければあまり意味が無いようにも思います。

他の人も読みやすいように・・・
今までの書き方や、書いてきた量が違うもの同氏が読みやすいソースコードというのはすごい難しい気がします。
書き方のルールを作って、遵守するとかでしょうか?

あ、朝礼で話をした時にも話がありましたが
ドキュメントはあてにならないから書かなくてもいいよね。って話ではないので
しっかり書きましょう!

Comments are closed.