読者です 読者をやめる 読者になる 読者になる

Perl日記

PerlとかRubyとかPHPとかPythonとか

なぜコーディング規約を守らなければならないのか

答え. 規約が守られていないと、そこばかり気になって肝心の「何をしているか」がぼやけるから。


(例). Pull Requestにて。「ここスペース空いてない。ここインデント揃ってない」「直した。マージおk?」「まだ見てねーよ」

(例). 機能追加にて。「この辺の既存コード横に長すぎだろ…、直したいけどいまは我慢我慢…(イライラ)」追加後。「あーさっきの部分、面倒くさいけど直して別コミットとして分けておかないと(だるい)」

まとめ

  • コーディング規約は守りましょう
    • 特別な例外の場合は、コメントとして目立つところに残しておきましょう
  • みんなが守りやすいようにドキュメントにしましょう
    • いつでも誰でも確認できる場所が望ましいです
  • 規約には理由があると、後々「なんでこれこんな約束なの?」と逐一聞かれなくて済みます
  • ひとりで全部開発している? 後任者のことを考えてあげるといいんじゃないかな