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

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

新規登録して質問してみよう
ただいま回答率
85.48%
PHP

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

CakePHP

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

Q&A

4回答

6900閲覧

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

smnsmn

総合スコア175

PHP

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

CakePHP

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

1グッド

3クリップ

投稿2016/04/22 05:49

編集2016/04/22 05:50

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

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

下記はPHPになりますが、

PHP

1//①変数などのイコール位置を合わせるか? 2$hogehoge = 'apple'; 3$color = 'red'; 4 5//②ifと()と{}の間に半角スペースを入れるか? →if(){}なのかif () {}なのか 6if ($hoge == 'apple') { 7 8 //③変数と文字列のつなげ方はどれが良いか 9 echo 'apple is '.$color.'.'; //基本シングル''+.で繋ぐ 10 echo "apple is $color."; //基本ダブル""で囲む 11 echo 'りんごは' . $color . 'です。'; //接続する.の前後にスペースを入れる 12 $str = 'りんごは'.htmlspecialchars($color).'です。'; //ここではhtml使ってませんがこういう変換をするときや 13 $query = 'SELECT * FROM `hoge` WHERE `color` = ' . mb_convert_encoding($color) . ''; //SQL文にするときなど 14 15} else { 16 echo 'not apple.'; 17}

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

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

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

PHP

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

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

yodel👍を押しています

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

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

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

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答4

0

一つだけ指摘します

PHP

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

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

投稿2016/04/22 07:52

KatsumiTanaka

総合スコア924

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

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

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

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

投稿2016/04/22 06:32

CodeLab

総合スコア1939

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

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

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

投稿2016/04/22 06:03

退会済みユーザー

退会済みユーザー

総合スコア0

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

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

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

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

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

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

投稿2016/04/26 04:40

退会済みユーザー

退会済みユーザー

総合スコア0

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

まだベストアンサーが選ばれていません

会員登録して回答してみよう

アカウントをお持ちの方は

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

ただいまの回答率
85.48%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問