(Für PHP-Projekte, zumindest - beachten Sie, dass PHP Open Source ist und hat eine wichtige Gemeinschaft, so sind viele Dinge ganz angetrieben durch das, was in der Gemeinde getan hat)
Zu allererst Wenn wir ein Framework für ein Projekt verwenden (dh immer), versuchen wir, an seiner Richtlinie festzuhalten, wenn klar definiert (es ist zumindest für Zend Framework der Fall): es stellt sicher, dass jeder, der zur Arbeit an diesem Projekt kommen kann :
- finden Sie eine Definition des Standards
- es auf anderen Projekten wiederverwenden, die den gleichen Rahmen
- auch verwenden, wenn an ein anderes Unternehmen oder arbeiten für einen anderen Kunden
- oder wenn von einem anderen Unternehmen kommen ;-)
gehen
In Anbetracht der Tatsache, dass wir nur zwischen 3 und 5 Frameworks für PHP-Projekte in der Firma verwenden, für die ich arbeite, und dass viele in ihren Standards definierte Regeln gleich sind, ist das kein wirkliches Problem.
Gleiches gilt, wenn zum Beispiel natürlich in einer Art CMS codiert wird.
Wenn er nicht einen speziellen Rahmen, versuchen wir unter der PHP-Community allgemein akzeptiert zu einem gemeinsamen Satz von Regeln zu halten: gleiche Art und Weise, ist es sicherzustellen, dass diese Regeln zu (auch von Neulingen bekannte unsere Firma), einfach zu finden, und dass viele Leute sie versucht und verbessert haben.
über Kommentare gibt es ein Werkzeug, das gut verwendet wird, in PHP: phpDocumentor (über die gleiche Sache wie javadoc); es definiert einen Standard - dies ist der De-facto-Standard, da es kein anderes Werkzeug gibt, das so oft verwendet wird.
Über spezifische Kommentar-Tags:
- wir verwenden immer @param/@return: sie in die IDE integriert sind, typ Hinting zu bieten, sind so nützlich
- sonst tun wir nicht verwende viel: ein paar Zeilen, um zu sagen, was die Methode macht, wenn sie nicht offensichtlich ist; ein paar Zeilen, wenn ein schwieriger Algorithmus verwendet wird.
Kamel-Fall oder andere: Wir halten, was sowohl unter der PHP-Community und Frameworks ist gemeinsam:
this_is_a_function
Und
ThisIsAClassName
Und
thisIsAMethodName
In HTML: so viel wie möglich, verwenden wir HTML-Kommentare nicht, weil sie an den Browser gesendet werden:
- bedeutet größere Seiten (ok, nicht so viel)
- bedeutet Informationen verlosen die Benutzer benötigt
Wenn möglich, verwenden wir Kommentare von der Templating-Engine.
In CSS: wir kommentieren, wenn nötig; wichtigere Sache ist, mehrere kleine CSS-Dateien zu verwenden, ziemlich spezifisch (selbst wenn ein Merge-Tool während des Build-Prozesses verwendet wird)
Aber, vielleicht wichtiger als all das: wir versuchen, "sauberen" Code zu verwenden, mit kleinen Methoden, die nur eine kleine "Einheit" Sache, mit selbstbeschreibenden Namen und alle
Es macht keine Magie, aber es hilft, den Code zu verstehen ... Und auch, es zu testen, Wiederverwendung es, ...
Auch, wie Nate sagte: das sind meist Richtlinien - außer wenn speziell von einem Kunden gefordert ... In diesem Fall müssen Sie setzen einige automatische Werkzeug (In Ihrem Build-Prozess, zum Beispiel) zu überprüfen, dass sie von dem Buchstaben gefolgt sind.
ich hinzufügen würde: „Unit-Test alles“ Sie könnten in Erwägung ziehen, "eine ORM-Ebene zu verwenden". –