PHP, HTML, Javascript und bewährte Methoden zum Schreiben

10

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

In der Webentwicklung bin ich genau wie in C ++ definitiv ein Fan von Einrückungen und Kommentaren.

Trotzdem stoße ich bei meiner Arbeit häufig auf HTML + JavaScript + PHP-Code, der plötzlich Kopfschmerzen verursacht.

Ich versuche, meinen Code lesbar zu machen, aber was mir besser erscheint (Einrücken und Kommentieren), scheint meine Teamkollegen nicht zu faszinieren. Deshalb habe ich mich gefragt, ob es beim Schreiben von "Hybrid" eine beste oder zumindest gemeinsame bewährte Methode gibt "Dokumente wie die heutigen Webseiten, die von Tag zu Tag komplexer werden.

Ich bin mir der Tatsache bewusst, dass es wahrscheinlich in der Natur des heutigen Codes von Webseiten liegt, ein wenig kompliziert zu sein, aber ich frage mich, ob es bereits eine gute Konvention in Bezug auf diese Aspekte gibt.

web-development php html javascript Federico Zancan
quelle

Antworten:

19

Einige allgemeine Regeln, denen ich folge:

Allgemeines

  • Einrückungen sind 4 Leerzeichen.
  • Neue Ebenen einrücken
  • Kommentare sind <~ 80 Zeichen von der Einrückungsstufe. Wenn ich mich in zwei Ebenen (8 Leerzeichen) befinde, bedeutet dies, dass der Cursor etwa 88 Zeichen lang ist.
  • Verwenden Sie mehrzeilige Kommentare. Ich bevorzuge das Aussehen, dies ist jedoch ein subjektiver Punkt.
  • Kommentieren Sie jetzt und nicht später, wenn Sie keine Ahnung haben, was los ist.
  • Zahnspangen im Allman-Stil . Es ist sauberer und besser lesbar. Subjektiv .

JavaScript

  • Verwenden Sie eine Bibliothek. Insbesondere jQuery ist sehr gut. Es beseitigt alle browserübergreifenden Kopfschmerzen.
  • Verstehen Sie, dass IDs für bestimmte Elemente gelten, Klassen für Stile. IDs sollten nicht mehr als einmal pro Seite verwendet werden, und sie sind mit bestimmten Hooks verbunden. Verwenden Sie Klassen für Dinge wie Navigation.
  • Quelle in Methoden. Es ist verlockend, den gesamten Code in den bindAufruf einzufügen. Wenn Sie ihn jedoch in eine eigene Funktion einfügen, erhöht sich die Flexibilität Ihres Codes.
  • Verwenden Sie Funktionen anstelle von Auswertungen. Das heißt setTimeout(function(){ /* Do something */ }, 1000);stattsetTimeout('doSomething', 1000);
  • Verwenden Sie lokale Variablen mit var.

HTML

  • Semantisches Markup. Verwenden Sie geeignete Tags. Fügen Sie dort keine <br />Leerzeichen ein, um Ränder und CSS-Regeln anzupassen.
  • Alle Tags sind Kleinbuchstaben .
  • Alle Tags sollten mit einem schließenden Tag enden oder sich selbst schließen .
  • Verwenden Sie Klassen für ein ähnliches Layout. Haben Sie ein paar vordefinierten Klassen mögen hide, clear, erroretc.
  • Alles (einschließlich Skripte) sollte rein gehen <head>. Sorgen Sie sich um die Optimierung (Verschieben von Dingen), wenn dies ein Problem darstellt.
  • Externe Stylesheets und JavaScript-Quellen sind ein Muss, sofern sie nicht seitenspezifisch sind.

PHP

  • Frameworks sind gut, ich empfehle CodeIgniter.
  • Wenn Sie kein Framework verwenden möchten, versuchen Sie, die neueste Version von PHP zu verwenden. (Das heißt 5.3).
  • Nutzen Sie includeszu Ihrem Vorteil.
  • Klare Injektionen oder vorbereitete Aussagen verwenden.

  • Durchführen, wenn vorgefasste ausfallsichere Werte überprüft werden.

    $logged_in = false;
if(check_user($user))
{
     $logged_in = true;
     $user = load_user($_SESSION);
}
  • Kennen Sie den Unterschied zwischen einfachen und doppelten Anführungszeichen. Verwenden Sie nach Möglichkeit einfache Anführungszeichen.
  • Echo nicht HTML.
Josh K.
quelle
4
Ausgezeichnete Liste. Für PHP würde ich hinzufügen 1) Vorlagen verwenden, PHP & HTML nicht mischen (zumindest in Anwendungen) 2) Includes () nicht als Funktionsaufrufe verwenden 3) so viel Code wie möglich außerhalb des globalen Bereichs halten.
Großmeister
Jeder, der CodeIgniter und jQuery empfiehlt, verliert jegliche Integrität in meinen Augen.
Mefisto
4
@teresko: Sie verurteilen ohne Angabe von Gründen oder Alternativen.
Josh K
+1. Eine Liste von streitbaren und umstrittenen Punkten, aber dennoch eine ziemlich gute Liste.
Haylem
jQuery beseitigt alle browserübergreifenden Kopfschmerzen?
James Adam
3

Es gibt einige Lesungen zur Inspiration:

  • Zend Framework - PHP-Codierungsstil : Liste der Methoden zum Schreiben von wartbarem PHP-Code (Formatierung von PHP-Dateien, Namenskonventionen, Codierungsstil: Arrays, Zeichenfolge, Klasse, Methode, z. B.).
  • Google - Code Style Guide : Liste der Methoden zum Schreiben von wartbarem Javascript-Code (Regeln: Constans, Semikolons, verschachtelte Funktion ..., Codierungsstil: Benennung, Bereich, Zeichenfolge, Sichtbarkeitsfelder usw.).
tomascejka
quelle
Würde es Ihnen etwas ausmachen, mehr darüber zu erklären, was diese Ressourcen bewirken, und warum empfehlen Sie diese als Antwort auf die gestellte Frage? "Nur-Link-Antworten" sind bei Stack Exchange nicht ganz willkommen
Mücke
1
@gnat bearbeiten / richtige Antwort
tomascejka
2

Halten Sie die 3 getrennt. Der am wenigsten wartbare Code, mit dem ich zu tun habe, ist immer dann, wenn es PHP gibt, das viel HTML und JavaScript wiedergibt, wahrscheinlich mit etwas SQL, das für ein gutes Maß herumgeworfen wird.

Wenn Sie alle getrennt halten, wird die Verwaltung des Codes erheblich vereinfacht und die Arbeit erheblich vereinfacht, wenn Mitarbeiter an verschiedenen Teilen der Anwendung arbeiten, z. B. Designer, die nur mit HTML / CSS arbeiten müssen.

GSto
quelle
2

Der einfachste Weg, eine PHP-Web-App zu codieren, besteht sicherlich darin, alles zusammenzufügen. Wenn Sie die Dinge so machen, kommt es jedoch schnell zu einem nicht zu wartenden Durcheinander.

Hier einige bewährte Methoden:

1) Fügen Sie Ihr JavaScript in den <head> eines Dokuments ein (oder noch besser in separate Dateien, auf die im head verwiesen wird). Erfahren Sie, wie Sie Ereignis-Listener in einem document.onload-Ereignis binden, anstatt sie in Ihrem HTML-Code zu verteilen. (Besser noch, lernen Sie, ein Framework wie Jquery zu verwenden; es wird Ihr JavaScript viel, viel schöner machen).

2) Suchen Sie nach Entwurfsmustern wie MVC. Sie möchten Ihre in PHP geschriebene Geschäftslogik so weit wie möglich von Ihrem HTML-Code trennen. Im Idealfall verwenden Sie eine schöne Vorlagensprache, um Ihre HTML-Seiten zusammenzustellen. Zumindest sollte das PHP in Ihrem HTML-Code knapp sein - hauptsächlich das Aufrufen von Variablen und das Durchlaufen von Listen, die an anderer Stelle erstellt wurden.

3) Kommentare, Einrücken ... das Zeug ist nur grundlegende Best Practices für die Programmierung. Ich neige dazu, meine Zeilenlänge beim Schreiben von HTML über 80 Zeichen zu lassen, nur weil die Sprache so verdammt ausführlich ist, aber das ist ungefähr die einzige traditionelle Praxis, die Sie abrutschen lassen sollten - wenn der Rest des Teams schlampig ist, sie müssen es aufsaugen und formen.

Patch
quelle
Netter Kommentar! Es gibt einen Tippfehler: "Fügen Sie Ihr JavaScript in ein Dokument ein"
DL
Hoppla. Vielen Dank. (Ich habe vergessen, in spitzen Klammern zu kodieren. Blöd mich.)
Patch
1
Javascript sollte aus Leistungsgründen am Ende Ihrer Seite stehen.
Toby
0

Hier sind ein paar Leckerbissen:

Javascript: Wird varbeim Initialisieren von Variablen verwendet.

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

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

Harry
quelle
Ich habe versucht, dem Google Javascript Style Guide zu folgen: google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml
Fosco