Was sind die am häufigsten Web-Entwicklungspolitik in Software-Unternehmen nutzen? [geschlossen]

Question

die beste Forum Website unter den Entwicklern zu haben, ich glaube, ich einen sehr guten Konsens finden werden, welche Politik und Best Practices machen gute Codierung. Ich werde einige von ihnen hier setzen, so dass ich der Idee geben, aber ich werde gerne Ihre Meinung hören und die Stimmen werden wahrscheinlich die Richter der besten Politik sein um.

• Spezifische Einrückungen für die Codierung zwischen Entwicklungsteams
• Besondere Bemerkungen vor jedem Verfahren vor jeder Variablendeklaration
• Namenskonventionen, Kamel Fall oder jede andere.
• In HTML nach jedem Container-Tag zu kommentieren.
• In CSS, jede Erklärung mit nur einmal.

Sie erhalten die Idee. Ich will gerne wissen, was die Dinge Unternehmen fragen uns zu tun, und was ist mit denen wirklich arbeiten, um wartbar und schönen Code zu erhalten.

Answer 1

würde ich alle Richtlinien konzentrieren sich rund um Entwicklungspraktiken, anstatt Code-Formatierung. Einige Beispiele sind:

• Verwenden Sie immer parametrisierte SQL-Abfragen. Nie concatenate Benutzereingaben in einer Abfrage.
• Halten Sie HTML, CSS und JavaScript in separaten Dateien.
• Verwenden Sie jslint oder ein gleichwertiges Werkzeug alle Zeit verpflichten Sie Code.
• Wählen Sie einen HTML-Standard (wie HTML 4.01 strict). Alle HTML müssen überprüfen.

Und nicht eine Politik-nazi sein. Manchmal müssen Regeln gebrochen, aber wird es sollte ein sehr guter Grund für dies zu tun.

Answer 2

• -Code besteht nicht, wenn es nicht unter Versionskontrolle ist. Genauer gesagt NICHTS auf einem Produktionsserver ist, wenn es in das Repository begangen wird.
• Wenn ein Projekt eine Gelegenheit bietet, alten Code Refactoring, dass die Gelegenheit wahrnehmen.
• Pflegen ein Wiki oder ähnlichen Dokumenten-Verfahren, Standards und die Verwendung von Bibliothekscode (wenn eine solche Dokumentation für die Code-Kommentare zu viel ist)

Answer 3

(für PHP-Projekte, zumindest - beachten Sie, dass PHP ist Open-Source und hat eine wichtige Gemeinschaft, so sind viele Dinge ganz angetrieben durch das, was in der Gemeinde getan hat)

Vor allem, wenn ein Rahmen an einem Projekt mit (dh immer), versuchen wir zu kleben, um ihre Politik, wenn klar definierte (es ist der Fall für Zend Framework, mindestens) : es sorgt für jedermann, kann an der Arbeit an diesem Projekt kommen wird:

• findet eine Definition des Standard
• verwenden Sie wieder es auf alle anderen Projekte, die den gleichen Rahmen verwenden
  • , auch wenn an ein anderes Unternehmen, oder arbeiten für einen anderen Kunden
  • oder, wenn sie von einem anderen Unternehmen kommt; -)

In Anbetracht wir nur zwischen 3 und 5 Frameworks für PHP-Projekte in der Firma, die ich Arbeit für und dass viele Regeln definiert in ihre Standards sind die gleichen verwenden, ist es kein wirkliches Problem.

Das gleiche gilt, wenn innerhalb Codierung / arround eine Art von CMS, zum Beispiel, natürlich.

Wenn er nicht einen speziellen Rahmen, versuchen wir Stick auf einen gemeinsamen Satz von Regeln weit unter der PHP-Community akzeptiert: gleiche Art und Weise, ist es sicherzustellen, dass diese Regeln bekennt (auch von Neulingen zu unserer Firma) , leicht zu finden, und dass viele Menschen haben versuchen, sie und verstärkt sie.

Über Kommentare gibt es ein Werkzeug, das in PHP gut genutzt wird: phpDocumentor (über die gleiche Sache wie javadoc) ; es definiert einen Standard -. dieser der de-facto-Standard ist, da es kein anderes Werkzeug, das so viel verwendet wird,

über spezifischen Kommentar-Tags:

• verwenden wir immer @param / @return: sie in die IDE integriert sind, typ anspielend zu bieten, so sind nützlich
• sonst, wir haben nicht viel nutzen: ein paar Zeilen zu sagen, was die Methode funktioniert, wenn es nicht offensichtlich ist; ein paar Zeilen, wenn ein schwieriger Algorithmus verwendet wird.

Kamel-Fall oder andere: Wir halten, was sowohl unter der PHP-Community gemeinsam ist und Frameworks:

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)
• Mittel verlosen Informationen den Benutzer nicht braucht

Wenn möglich, nutzen wir die Kommentare aus dem Templating-Engine.

In CSS: Kommentar wir bei Bedarf; mehr wichtige Sache ist, mehrere kleine CSS-Dateien, ganz bestimmt (wenn auch mit einem Merge-Tool während des Erstellungsprozesses)

zu verwenden,

Aber vielleicht noch wichtiger als all dies: wir versuchen, „sauberen“ Code, mit kleinen Methoden zu verwenden, die nur eine kleine „Einheit“ etwas tun, mit selbstbeschreibenden Namen und alle

Es ist nicht Magie, aber es hilft, den Code zu verstehen ... Und auch, testet es, erneut zu verwenden es, ...

Auch, wie Nate sagte: Diese sind meist Richtlinien - es sei denn, speziell von einem Client erforderlich ... In diesem Fall können Sie einige automatische Werkzeug zu setzen haben (In Ihrem Build-Prozess, zum Beispiel) , um zu überprüfen sie sind mit dem Buchstaben gefolgt.