質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.47%

  • PHP

    20812questions

    PHPは、Webサイト構築に特化して開発されたプログラミング言語です。大きな特徴のひとつは、HTMLに直接プログラムを埋め込むことができるという点です。PHPを用いることで、HTMLを動的コンテンツとして出力できます。HTMLがそのままブラウザに表示されるのに対し、PHPプログラムはサーバ側で実行された結果がブラウザに表示されるため、PHPスクリプトは「サーバサイドスクリプト」と呼ばれています。

  • CakePHP

    2355questions

    CakePHPは、PHPで書かれたWebアプリケーション開発用のフレームワークです。 Ruby on Railsの考え方を多く取り入れており、Railsの高速性とPHPの機動性を兼ね備えています。 MVCやORMなどを「規約優先の考え方」で利用するため、コードを書く手間を省くことができます。 外部のライブラリに依存しないので、単体での利用が可能です。

PHP(に限らずですが)可読性の良い書き方について

受付中

回答 4

投稿 編集

  • 評価
  • クリップ 3
  • VIEW 1,526

smnsmn

score 160

プログラミングに少しずつ慣れてきたところで、
可読性というものをもう少し気にしなければと思うようになりました。

実際、まだまだ未熟な点もあり、書いている処理自体がそもそもスマートでないのも問題なのですが、
ちょっとしたスペースやインデントの使い方、改行だけでももう少し改善できたらと思い、質問させて頂きました。

下記はPHPになりますが、

//①変数などのイコール位置を合わせるか?
$hogehoge = 'apple';
$color         = 'red';

//②ifと()と{}の間に半角スペースを入れるか? →if(){}なのかif () {}なのか
if ($hoge == 'apple') {

 //③変数と文字列のつなげ方はどれが良いか
 echo 'apple is '.$color.'.'; //基本シングル''+.で繋ぐ
 echo "apple is $color."; //基本ダブル""で囲む
 echo 'りんごは' . $color . 'です。'; //接続する.の前後にスペースを入れる
 $str     =  'りんごは'.htmlspecialchars($color).'です。'; //ここではhtml使ってませんがこういう変換をするときや
 $query = 'SELECT * FROM `hoge` WHERE `color` = ' . mb_convert_encoding($color) . ''; //SQL文にするときなど

} else {
 echo 'not apple.';
}

かなり雑で、場合によるよ!!というものもありますが、こうしたほうがメリットがある。可読性がある。
こんな書き方しません!ここはこだわったり統一しています!という書き方があれば、教えて頂けますと幸いです。

ちなみに私は
if(◯◯){
 //処理
}
と、スペース入れない派だったのですが、他の方のソースをみているとir (◯◯) { と間にスペースを入れたり、
コメントアウトも「// 処理」のようにスペース入れていたりしてどっちがいいのかな〜と思っています。
( カッコ内 )にもスペースを入れている方も見ますが、何度も(カッコ)が出てきてスペースがあるものと無いものがあって、
どういう基準で入れてるのかな?と思いましたので、スペース入れる派の方がいればコメントいただけると嬉しいです。

また、インデントについてですが、処理と処理の間を改行しているとき、空行にもインデントを入れていますか?

//④インデントを「ー」で表しています。if終了後〜$fooまでの空行にも、インデントを入れるか否か
ーー$hoge = 'インデント';
ーー
ーーif ($hoge = 'インデント') {
ーーー//処理
ーー}
ーー
ーー
ーー$foo = 'スペース';

技術の関係ない質問で恐れ入りますが、何卒よろしくお願い致します。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 4

+2

phpのコーディング規約、いくつかあります。
PSR-2準拠を頑張るというのはいかがでしょうか。

参考:
PHPコーディング規約まとめ - Qiita
http://qiita.com/hshimo/items/04be1f432240c58300f4

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+2

何が正解というものはないです。
オープンソースのフレームワークなど使っているのであれば、それに合わせるのが良いと思います。

すでにいろいろなところがコーディング規約を作っているので、自分の書き方に合ったものを探してそれに合わせていくほうが良いです。

ただ、あまり規約にこだわりすぎると、それがストレスになって作業がはかどりません。
たとえば、転職や派遣先の変更などでコーディング規約を変えざるを得ない時にクセとなって出てしまい大変です。
必要最低限かつ簡潔なものを選択することをお勧めします。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+2

一つだけ指摘します

$query = 'SELECT * FROM `hoge` WHERE `color` = ' . mb_convert_encoding($color) . '';

これは、SQLインジェクション攻撃の対象となりますので、やってはダメです
フレームワークとしてCakePHPを使うのであればフレームワークが用意するやり方に従うか、またはバインド変数を使うようにするほうがよいと思います

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+1

半角スペースをいれるのは、文字の詰まりを防ぎ
かつ、修正するときにプログラムのコード消しすぎを極力抑える為だと思います。
急に見たことのないのバグがでて、よくよく調べてみたら
いつのまにか、かっこの片割れ消しちゃってたってのはよくあるので。

また、質問から逸れますがif文で異常処理、正常処理を分ける場合、以下のように心がけています。 

if (異常ケースの場合){
    異常処理

} else {
    正常処理

}


異常処理はだいたい短いので、一目で異常処理と正常処理を確認できます。
逆に書いてしまうと、長い正常処理を見てからでないと異常処理を確認できません。

最後に、空行へのインデントですが、入れてません。
必要性を感じない為です。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

関連した質問

同じタグがついた質問を見る

  • PHP

    20812questions

    PHPは、Webサイト構築に特化して開発されたプログラミング言語です。大きな特徴のひとつは、HTMLに直接プログラムを埋め込むことができるという点です。PHPを用いることで、HTMLを動的コンテンツとして出力できます。HTMLがそのままブラウザに表示されるのに対し、PHPプログラムはサーバ側で実行された結果がブラウザに表示されるため、PHPスクリプトは「サーバサイドスクリプト」と呼ばれています。

  • CakePHP

    2355questions

    CakePHPは、PHPで書かれたWebアプリケーション開発用のフレームワークです。 Ruby on Railsの考え方を多く取り入れており、Railsの高速性とPHPの機動性を兼ね備えています。 MVCやORMなどを「規約優先の考え方」で利用するため、コードを書く手間を省くことができます。 外部のライブラリに依存しないので、単体での利用が可能です。