PHP、HTML、JavaScript、およびライティングの優れた実践方法

softwareengineering.stackexchange https://softwareengineering.stackexchange.com/questions/9584

質問

私と私のチームのために、HTML、JavaScript、および PHP コーディングに関する規約仕様を書き留める必要があることに気づきました。

Web 開発では、C++ と同様に、私はインデントとコメントのファンです。

それにもかかわらず、仕事中に HTML+JavaScript+PHP コードに遭遇すると、突然頭が痛くなることがあります。

コードを読みやすくしようとしているのですが、自分にとってより良いと思われる方法 (インデントとコメント) がチームメイトを魅了していないようです。 " ドキュメントは今日の Web ページと同じで、日に日に複雑になっていきます。

おそらく今日の Web ページのコードは本質的に少し複雑であるという事実は承知していますが、これらの側面に関する適切な規則がすでに存在するのだろうかと疑問に思います。

役に立ちましたか？

解決

私が従う一般的なルールは次のとおりです。

一般的な

  • インデントはスペース4つです。
  • 新しいレベルをインデントする
  • コメントはインデント レベルから最大 80 文字以内です。2 レベル (8 スペース) にいる場合、カーソルは約 88 文字で停止することになります。
  • 複数行のコメントを使用します。見た目は好みですが、これは 主観的な ポイント。
  • 何が起こっているのかわからない場合は、後でコメントするのではなく、今コメントしてください。
  • オールマンスタイルの矯正器具. 。よりクリーンで読みやすくなりました。 主観的.

JavaScript

  • 図書館を利用しましょう。特にjQueryは非常に優れています。これにより、ブラウザ間の問題がすべて解消されます。
  • ID は特定の要素用であり、クラスはスタイル用であることを理解してください。ID はページごとに複数回使用しないでください。ID には特定のフックが付けられます。ナビゲーションなどにはクラスを使用します。
  • ソースをメソッドにアウトします。すべてのコードを bind ただし、それを独自の関数に含めると、コードの柔軟性が高まります。
  • eval の代わりに関数を使用します。つまり、 setTimeout(function(){ /* Do something */ }, 1000); の代わりに setTimeout('doSomething', 1000);
  • ローカル変数を使用する var.

HTML

  • セマンティックマークアップ。適切なタグを使用してください。置かないでください <br />スペースを追加したり、マージンや CSS ルールを調整したりするために、 が含まれています。
  • すべてのタグは、 小文字.
  • すべてのタグは 終了タグで終わるか、自動的に終了する.
  • 同様のレイアウトにはクラスを使用します。次のような事前定義されたクラスがいくつかあります hide, clear, error, 、など。
  • すべて（スクリプトを含む）が入るはずです <head>. 。問題が発生した場合は、最適化 (要素の移動) について心配してください。
  • 外部スタイルシートとJavaScriptソース 必須です ページ固有でない限り。

PHP

  • フレームワークは優れているので、CodeIgniter をお勧めします。
  • フレームワークを使用したくない場合は、可能な限り最新バージョンの PHP を使用するようにしてください。(つまり 5.3)。
  • 使用 includes あなたの利益のために。
  • インジェクションをクリアするか、準備されたステートメントを使用します。

  • 事前に設定されたフェイルセキュア値の if チェックを実行します。

    $logged_in = false;
if(check_user($user))
{
     $logged_in = true;
     $user = load_user($_SESSION);
}
  • 一重引用符と二重引用符の違いを理解してください。可能な場合は一重引用符を使用してください。
  • HTML をエコーし​​ないでください。

他のヒント

3を別々に保ちます。私が扱う最も保守性の低いコードは、常に多くのHTMLとJavaScriptを反映しているPHPがあるときであり、おそらくSQLが適切な尺度で投げ込まれています。

それらすべてを別々に保つことで、コードの維持がはるかに容易になり、HTML/CSSのみを使用する必要があるデザイナーなど、アプリケーションのさまざまな部分で作業している人がいる場合、物事がより合理化されます。

インスピレーションのための読書がいくつかあります：

  • Zend Framework -PHPコーディングスタイル ：プラクティスのリストメンテナブルPHPコードの書き方（PHPファイルのフォーマット、命名規則、コーディングスタイル：配列、文字列、クラス、方法など）。
  • Google-コードスタイルガイド ：プラクティスのリストメンテナブルJavaScriptコードを書き込む方法（ルール：Constans、Semicolons、Nested機能...、コーディングスタイル：ネーミング、スコープ、文字列、視認性フィールドなど）。

PHP Webアプリをコーディングする最も簡単な方法は、確かにすべてをマッシュすることです。ただし、そのようにしてやると、すぐに維持できない混乱に巻き込まれます。

ここにいくつかの良い実践があります：

1）JavaScriptを入れますu003Chead>ドキュメントの（または、さらに良いことに、ヘッドで参照される別々のファイル）。 HTMLを通して散乱するのではなく、ドキュメントでイベントリスナーをバインドする方法を学びます。 （さらに良いことに、jQueryのようなフレームワークを使用することを学びます。それはあなたのJavaScriptをはるかにきれいにします）。

2）MVCのようなデザインパターンを検索します。 PHPで書かれたビジネスロジックを、できるだけHTMLから分離したいと考えています。理想的には、HTMLページをまとめるために素敵なテンプレート言語を使用することになります。少なくとも、HTMLのPHPは簡潔である必要があります。主に変数を呼び出し、他の場所で構築されたリストをループします。

3）コメント、インデント...そのようなものは、基本的なプログラミングのベストプラクティスです。私はHTMLを書いているときに80文字を上回る傾向があります。言語が非常に冗長であるからといって、それはあなたがスライドさせるべき唯一の伝統的な練習についてです - チームの残りの部分がずさんである場合、彼らはそれを吸い上げて形作る必要があります。

これがいくつかの情報です：

JavaScript：使用 var 変数を初期化するとき。

HTML：ファイルの下部にスクリプトを含めて、最後にロードします。

PHP：ファイルを分割します。通常のC ++開発ではないように、すべてのクラスを1つのファイルに入れないでください。可能な限りコメントし、機能/クラスの目的を書き留めてください。

ライセンス： CC-BY-SA と 帰属
所属していません softwareengineering.stackexchange
scroll top