• WEB

PHPerとして守るべきルール「Zend Framework PHP 標準コーディング規約」

  • ピンポン
    ピンポン システムちーむ
  • このエントリーをはてなブックマークに追加
PHPerとして守るべきルール「Zend Framework PHP 標準コーディング規約」

お久しぶりです!ピンポンでございます。

PHPerとして、少しずつ成長しているであろう今日この頃。
自分はまだまだ勉強中の身ですので、皆さまに教えることはあまりございません……
ですので、今回は「仕事の心得」について自分なりに書いていきたいと思います。

まずは、「仕事の心得」第一弾です。

zendconding_yellow

Zendコーディング規約

基本中の基本だと思いますが、この「コーディング規約」、実は結構気にしない人が多いようです。

プログラミング習い始めの頃、先生から「皆さんも綺麗なコードを書くようにしてください」と教えられた人も多いはず。
しかしプログラムが正しく動く以上は、先生はそこまで細かくコードについて指摘してくれなかったでしょう。
その為、括弧の位置ズレやスペースのつけ忘れなどはよくあったと思います。

しかし、本格的にプログラミングを仕事として始めたらそうはいきません。
システムの保守性を高めるためには、可読性に優れて読みやすいコードが基本となります。
読みやすい綺麗なコードは、誰にでも管理がしやすく、また、作業時間を大幅に短縮することが出来るので、仕事では必須条件となります。

入社してしばらく経ったある日の出来事

うすきさん: Zendコーディング規約に沿ってソースコードを書きましょう。

ピンポン : えっ!それはなんですか?

うすきさん: じゃあ、Zendコーディングで検索してみて。

ピンポン : (´・ω・`)

Zend Framework PHP標準コーディング規約
この時初めてコーディング規約の存在を知りましたorz

それから1年半やってきた感想としては、「ソースを読むときは、やはり綺麗なコードが読みやすい!」

元々わかりにくい複雑なロジック部分などは、ただでさえ読む気になれない(ピンポンだけかもしれません)のに、その上、規約無視のソースコードで書かれていた場合には地獄です。理解不能です!
ですが、綺麗なコードで書かれていれば、句読点が加わったかのように難解なソースが読みやすくなります。

チーム作業は他人のソースを触ることがほとんどです。
誰が見ても読みやすいコードを書くように皆さんも心掛けましょう。

おまけ


Zendコーディング規約には下記ルールがあります。

字下げは空白 4 文字で行います。タブ文字を使ってはいけません。

システムチームに入った初日に、自分のPCに作業環境の構築作業があるのですが、そのマニュアルには下記の記述があります。

☆EmEditorの設定
「タブ/インデント」→「タブの代わりに空白を挿入」→「4」「4」

※当社は主に「EmEditor」というテキストエディタを使ってます。

この手順は他のチームにも設定してほしいなぁ~……
タブの代わりにスペースを挿入する設定をしていなかったので以前のソースがタブだらけ……どうしよう?
そんな時はコレ!!

EmEditor


当社の標準使用エディタ。
「ツール」/「すべての設定のプロパティ」/「ファイル」/「保存時」をクリックして、
「□保存時、タブをスペースに変換」の選択肢にチェックを入れるだけ。
ファイルを保存する度に自動的にタブ⇒スペースに変換してくれるんです。

emeditorSetting111

Sublime Text

このエディタも最近流行っていますね。
Sublime Text
「View」/「Indentation」/「Convert Indentation to Spaces」クリックすれば、タブ⇒スペースに変換する事が出来ます。

これで綺麗なソースにまた一歩近づけますね。
ぜひお試しください。

このエントリーをはてなブックマークに追加

ピンポンが最近書いた記事

WRITERS POSTS もっと見る

他にもこんな記事が読まれています!

  • WEB
  • マーケティング
  • サーバー・ネットワーク
  • ライフスタイル
  • お知らせ