PHP, HTML, JavaScript und schreiben gute Praktiken

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

Frage

Mir wurde klar, dass ich eine Kongressspezifikation über HTML, JavaScript und PHP -Codierung für mich und mein Team aufschreiben muss.

In der Webentwicklung bin ich, genau wie in C ++, definitiv ein Fan von Einkerbungen und Kommentaren.

Trotzdem stoße ich in meiner Arbeit auf HTML+JavaScript+PHP -Code, der plötzlich die Kopfschmerzen erhöht.

Ich versuche, meinen Code lesbar zu machen, aber was für mich besser zu sein scheint (um einzutreten und zu kommentieren), scheint meine Teamkollegen nicht zu faszinieren. Deshalb habe ich mich gefragt, ob es beim Schreiben eine beste oder zumindest gemeinsame Praxis gibt "Hybrid" Hybrid "Dokumente genau wie die heutigen Webseiten, die von Tag zu Tag immer komplexer werden.

Ich bin mir der Tatsache bewusst, dass es wahrscheinlich in der Natur des heutigen Webseiten -Code ist, ein bisschen integriert zu sein, aber ich frage mich, ob es sich bereits um eine gute Konvention dieser Aspekte handelt.

War es hilfreich?

Lösung

Einige allgemeine Regeln, die ich folge:

Allgemein

  • Eingeweide sind 4 Leerzeichen.
  • NEUE NEUE NEWS
  • Kommentare sind <~ 80 Zeichen aus der Einrückungsstufe. Wenn ich in zwei Ebenen bin (8 Leerzeichen), bedeutet dies, dass der Cursor -Stopp rund 88 Zeichen beträgt.
  • Verwenden Sie Multi-Line-Kommentare. Ich bevorzuge den Look, aber das ist ein subjektiv Punkt.
  • Kommentieren Sie jetzt noch später, wenn Sie keine Ahnung haben, was los ist.
  • Allman Style -Klammern. Es ist sauberer und lesbarer. Subjektiv.

JavaScript

  • Verwenden Sie eine Bibliothek. Insbesondere JQuery ist sehr gut. Es eliminiert alle Kreuzschmerzen im Kreuzbrowser.
  • Verstehen Sie, dass IDs für bestimmte Elemente sind, Kurse für Stile. IDs sollten nicht mehr als einmal pro Seite verwendet werden und sie haben bestimmte Haken an ihnen. Verwenden Sie Kurse für Dinge wie Navigation.
  • Quelle in Methoden aussteigen. Es ist verlockend, den gesamten Code in die zu setzen bind Rufen Sie jedoch an, aber in seine eigene Funktion wird die Flexibilität Ihres Codes erhöht.
  • Verwenden Sie Funktionen anstelle von Evalen. Das bedeutet setTimeout(function(){ /* Do something */ }, 1000); Anstatt von setTimeout('doSomething', 1000);
  • Verwenden Sie lokale Variablen mit var.

Html

  • Semantisches Markup. Verwenden Sie entsprechende Tags. Nicht ausdrücken <br />Anhand von Platz, um Platz zu hindern, stellen Sie die Rand- und CSS -Regeln ein.
  • Alle Tags sind Kleinbuchstaben.
  • Alle Tags sollten enden mit einem Schlussetik.
  • Verwenden Sie Klassen für das Layout, das ähnlich ist. Habe ein paar vordefinierte Klassen wie hide, clear, error, etc.
  • Alles (gehörte Skripte) sollte hineingehen <head>. Sorgen Sie sich um das Optimieren (Umzug), wenn es ein Problem darstellt.
  • Externe Stylesheets und JavaScript -Quelle ist ein Muss Es sei denn, es ist Seitenspezifikum.

Php

  • Frameworks sind gut, ich empfehle Codesigniter.
  • Wenn Sie kein Framework verwenden möchten, versuchen Sie, die neueste Version von PHP möglich zu verwenden. (Das bedeutet 5.3).
  • Verwenden includes zu Ihrem Vorteil.
  • Löschen Sie Injektionen oder verwenden Sie vorbereitete Aussagen.

  • Führen Sie bei Überprüfungen über vorgefasste Fail-Secure-Werte durch.

    $logged_in = false;
if(check_user($user))
{
     $logged_in = true;
     $user = load_user($_SESSION);
}
  • Kennen Sie den Unterschied zwischen Einzel- und Doppelzitaten. Verwenden Sie nach Möglichkeit einzelne Zitate.
  • HTML nicht wiederholen.

Andere Tipps

Halten Sie die 3 getrennt. Der am wenigsten gewartbare Code, mit dem ich mich befasse, ist immer, wenn es einen PHP gibt, der viel HTML & JavaScript ausspricht, wahrscheinlich mit einigen SQL, die für ein gutes Maß herumgeworfen werden.

Wenn Sie alle als getrennt halten, erleichtert der Code viel einfacher zu pflegen und macht die Dinge auch viel optimierter, wenn Menschen an verschiedenen Teilen der Anwendung arbeiten, z. B. Designer, die nur mit dem HTML/CSS arbeiten müssen.

Es gibt einige Lesen als Inspiration:

  • Zend Framework - PHP -Codierungsstil : Liste der Praktiken zum Schreiben von Mauringable PHP -Code (PHP -Dateiformatierung, Benennung von Konventionen, Codierungsstil: Arrays, String, Klasse, Methode z. B.).
  • Google - Code Style Guide : Liste der Praktiken zum Schreiben von Mauring -JavaScript -Code (Regeln: Constans, Semikolons, verschachtelte Funktion ..., Codierungsstil: Benennung, Umfang, String, Sichtbarkeitsfelder usw.).

Der einfachste Weg, eine PHP -Web -App zu codieren, besteht sicherlich darin, alles zusammen zu zerdrücken. Sie landen schnell mit einem unbeschreiblichen Chaos, wenn Sie die Dinge auf diese Weise tun.

Hier sind einige gute Praktiken:

1) Setzen Sie Ihr JavaScript in dieu003Chead> eines Dokuments (oder noch besser in separaten Dateien, auf die im Kopf verwiesen wird). Erfahren Sie, wie Sie Ereignishörer in einem Dokument binden. (Besser noch, lernen Sie, ein Framework wie JQuery zu verwenden; es wird Ihr JavaScript viel, viel hübscher machen).

2) Schauen Sie sich Designmuster wie MVC an. Sie möchten Ihre in PHP geschriebene Geschäftslogik so weit wie möglich von Ihrem HTML trennen. Im Idealfall verwenden Sie eine schöne Vorlagensprache, um Ihre HTML -Seiten zusammenzustellen. Zumindest sollte der PHP in Ihrem HTML knapp sein - hauptsächlich aufrufen Variablen und durchlisten durch Listen, die an anderer Stelle gebaut werden.

3) Kommentare, Einrückung ... Das Zeug ist nur grundlegende Programmierbest -Practices. Ich neige dazu, meine Zeilenlänge über 80 Zeichen zu lassen, wenn ich HTML schreibe, nur weil die Sprache so verdammt ausführlich ist, aber das ist ungefähr die einzige traditionelle Praxis, die Sie rutschen lassen sollten - wenn der Rest des Teams schlampig ist, Sie müssen es ansaugen und formen.

Hier sind ein paar Leckerbissen:

JavaScript: Verwendung var Bei der Initialisierung von Variablen.

HTML: Fügen Sie Skripte unten in der Datei ein, damit sie zuletzt geladen werden.

PHP: Teilen Sie die Dateien auf. Legen Sie nicht alle Ihre Klassen in eine Datei ein, genauso wie Sie es nicht in der normalen Entwicklung von C ++ tun würden. Kommentieren Sie so viel wie möglich und schreiben Sie auch den Zweck Ihrer Funktionen/Klassen auf.

Lizenziert unter: CC-BY-SA mit Zuschreibung
scroll top