多くの場合、PHP の最も価値のある機能は、その緩い構文であるという最大の弱点でもあります。 PHP が広く使用されているのは、経験の浅い Web 開発者の多くが計画、一貫性、ドキュメント化についてあまり心配することなく強力なアプリケーションを作成できるためです。
残念ながら、まさに上記の特性のため、多くの PHP ソース コードは肥大化し、読みにくく、さらには保守が不可能になってしまいます。私はこのコードを何度も書いてきたので、このことを深く理解しています。
上記の状況やその他の多くの状況を回避するため。多くのコア PHP 開発者とコミュニティ メンバーが集まり、PHP 拡張機能とプラグイン リポジトリを増やすことに重点を置いたプロジェクトである PEAR を開始しました。現時点では、PEAR プロジェクトのドキュメントやその他のコンテンツは少なく、この記事は開発者 (PEAR チーム) が何をしているのかを伝えることを目的としています。
コードの保守性を決定する重要な要素は、コードの形式とコメントです。プロジェクトのすべてのコードは、一貫した方法で編成する必要があります。私はコードベースにこだわる人間ですが、プログラマーもそうすべきだと思います。
(1) インデント
すべての開発者のコードは、インデント方法に従って正確に記述される必要があります。これは、コードの可読性を向上させるための最も基本的な対策です。コードにコメントを付けない場合でも、コードを他の人が理解しやすくするためにインデントは非常に役立ちます。
例:
while ($x if ($a == 1) {
echo 'A は 1 に等しい'
} else {
if ($b == 2) {
/ /do something else
} else {
//do something else
}
}
}
PEAR ドラフト標準では、インデントにタブの代わりに 4 つのスペースを使用する必要があります。私個人としてはこの考え方には同意できないので、今後もタブキーを使い続けると思います。タブを使用すると、複数のスペースよりもファイルが小さくなると思います。また、ファイルが小さいほど、解釈、アップロード、ダウンロードなどをより速く行うことができます。タブを使用するもう 1 つの大きな利点は、他の人のコードを表示するときに、タブ キーのスペースの数を自分で設定できることです。私は普段タブキーの設定を半角スペース8文字にしていますが、最近は半角スペース4文字に変更しました(笑)、これを個人的な趣味でコード再フォーマットと呼んでいます。
(2) 制御構造
これは個人の好みに大きく依存します。分岐ステートメントのない制御構造コードがまだ多くあり、その結果、可読性が非常に低くなります。分岐のない IF ステートメントを使用すると、可読性が悪化するだけでなく、他の人がプログラムを変更したときに、多くのエラーが発生します。バグ。次の例を参照してください:
悪い例:
if ($a == 1) echo 'A は 1 に等しかった';
これは非常に読みにくいです。それはうまくいきますが、あなた以外には誰もそれを評価しません。
改良された例:
if ($a == 1)
echo 'A was等しい 1';
これで、少なくともこのコードは読み取れるようになりましたが、まだ保守性は高くありません。 $a==1 のときに追加のイベントを発生させたい場合、またはブランチを追加する必要がある場合はどうすればよいですか?後のプログラマーが中括弧や else キーワードを追加するのを忘れると、プログラムにバグが発生します。
完璧な例
if (($a == 1) && ($b==2)) {
echo 'A は 1 に等しかった'
//他のコードを追加するのは簡単です
} elseif (($ a == 1) && ($b==3)) {
//その他の操作
}
if と elseif の後のスペースに注意してください。これにより、このステートメントは関数呼び出しと区別されますが、elseif にはありません。実行プログラム部分のステートメント、コメントのみ。一見冗長に見えますが、将来プログラムを保守するプログラマーにとって非常に便利なヒントを提供し、機能を追加するのに非常に役立ちます。