web-dev-qa-db-ja.com

PHP、HTML、JavaScript、および優れたプラクティスの記述

私はHTML、JavaScript、およびPHPコーディングについて、私と私のチームのためにコーディングする必要があります。

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

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

私はコードを読みやすくしようとしていますが、インデントとコメントを付けるために私にとってより良いように見えるものは、チームメイトを魅了しないようです。そのため、「ハイブリッド"今日のWebページと同じように、日々複雑になるドキュメント。

おそらく今日のWebページのコードの性質が少し複雑であることは承知していますが、これらの側面に関する良い慣習がすでに存在しているかどうかは疑問です。

web-developmentphphtmljavascript
10
Federico Zancan

私が従ういくつかの一般的なルール：

一般的な

  • インデントは4つのスペースです。
  • 新しいレベルをインデントする
  • コメントは、インデントレベルから80文字未満です。 2つのレベル（8スペース）にいる場合、カーソルの停止位置は約88文字になります。
  • 複数行コメントを使用します。私は見た目を好みますが、これは主観的ポイントです。
  • 何が起こっているのか分からない場合は、後でコメントするのではなく、後でコメントしてください。
  • オールマンスタイルのブレース 。よりクリーンで読みやすくなります。 主語。

JavaScript

  • ライブラリを使用します。特にjQueryは非常に優れています。それはすべてのクロスブラウザの頭痛を取り除きます。
  • IDは特定の要素用であり、クラスはスタイル用であることを理解してください。 IDはページごとに1回以上使用しないでください。また、特定のフックが付加されます。ナビゲーションなどにクラスを使用します。
  • ソースをメソッドに出力します。すべてのコードをbind呼び出しに入れるのは魅力的ですが、それを独自の関数に入れると、コードの柔軟性が向上します。
  • Evalの代わりに関数を使用します。つまり、setTimeout(function(){ /* Do something */ }, 1000);ではなくsetTimeout('doSomething', 1000);になります。
  • varでローカル変数を使用します。

HTML

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

PHP

  • フレームワークは優れています。CodeIgniterをお勧めします。
  • フレームワークを使用したくない場合は、PHP可能）の最新バージョンを使用してみてください（つまり、5.3を意味します）。
  • includesを利用してください。
  • 注入をクリアするか、準備されたステートメントを使用します。

  • 先入観のあるフェイルセキュア値をチェックするかどうかを実行します。

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

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

  • Zend Framework-phpコーディングスタイル ：メインテーブルphpコードの記述方法のリスト（PHPファイルのフォーマット、命名規則、コーディングスタイル：配列、文字列、クラス、メソッドなど）。
  • Google-コードスタイルガイド ：保守可能なJavaScriptコードを記述する方法のリスト（ルール：コンスタンス、セミコロン、ネストされた関数...、コーディングスタイル：ネーミング、スコープ、文字列、可視性フィールドなど）。
3
tomascejka

PHP Webアプリをコーディングする最も簡単な方法は、すべてをまとめることです。ただし、その方法で行うと、保守不能な混乱にすぐに巻き込まれてしまいます。

ここにいくつかの良い習慣があります：

1）JavaScriptをドキュメントの<head>に配置します（または、より適切には、ヘッドで参照される個別のファイルに配置します）。 htmlを通じてイベントリスナーを分散させるのではなく、document.onloadイベントでイベントリスナーをバインドする方法を学びます。 （さらに良いことに、Jqueryのようなフレームワークの使い方を学んでください。これにより、JavaScriptがより美しくなります）。

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

3）コメント、インデント...これらは基本的なプログラミングのベストプラクティスにすぎません。 HTMLを記述しているときは、行の長さが80文字を超えてしまう傾向があります。これは、言語が非常に冗長であるためですが、これは、スライドを許可する必要がある従来の唯一の方法です。チームの他のメンバーがずさんな場合は、彼らはそれを吸い上げて形を整える必要があります。

2
Patch

3つは別々にしてください。私が扱う最も保守しにくいコードは、常にいくつかのPHPがあり、それが多くのHTMLとJavaScriptをエコーし​​ている場合であり、おそらくいくつかのSQLが適切な方法で発生します。

これらすべてを個別に保持することで、コードの保守がはるかに簡単になり、HTML/CSSでのみ作業する必要があるデザイナーなど、アプリケーションのさまざまな部分で作業する人がいる場合は、作業が大幅に簡素化されます。

2
GSto

ここにいくつかのヒントがあります：

Javascript：変数を初期化するときにvarを使用します。

HTML：最後に読み込まれるように、ファイルの下部にスクリプトを含めます。

PHP：ファイルを分割します。通常のC++開発とは異なり、すべてのクラスを1つのファイルに配置しないでください。できるだけコメントを付け、関数/クラスの目的を書き留めます。

0
Harry