Was sind allgemein akzeptierte code-Formatierung Richtlinien?

Question

Nach McCall ' s-Qualität-Modell, Produkt Überarbeitet ist einer der drei wichtigsten Perspektiven für die Beschreibung der Qualität Attribute eines software-Produkts.Unter dem Produkt, Revision Perspektive, Wartbarkeit, die Fähigkeit zu finden und zu beheben eines Mangels, ist identifiziert als ein Schlüssel Faktor für die Qualität, die Auswirkungen auf die Fähigkeit zur überarbeitung der software.

Klar, an einem gewissen Punkt in der überarbeitung, es ist eine Notwendigkeit für die menschliche Mitwirkung, insbesondere Programmierer Beteiligung.Die Formatierung des Codes hat Auswirkungen auf das programmer ' s Fähigkeit zu überarbeiten die software effektiv und effizient.

Das, was allgemein akzeptiert, language-agnostic code-Formatierung Richtlinien haben Sie gearbeitet, dass Programmierer maximieren Sie Effizienz und Effektivität in der code für die überprüfung?

Answer 1

Die besten Richtlinien, mit dem ich gearbeitet habe, ist die Konsistenz.Im Laufe der Jahre habe ich eine Menge von verschiedenen Stilen, mit verschiedenen teams ...die besten Ergebnisse, die ich gesehen habe, ist, wenn das ganze team ist gezwungen, den gleichen Stil, unabhängig davon, was Stil ist :-)

Answer 2

Ich habe ein paar Gedanken über einige sprachneutral-Konzepte:

1.) Entfernen Sie tote code.Es sei denn, etwas ist absolut notwendig, auskommentierte, Toten code entfernt werden sollte.Es unübersichtlich bis eine routine ist, werden Sie oft falsch positive Ergebnisse, wenn Sie suchen für einige string-und es zeigt sich eine Allgemeine Schlamperei ist das nicht gut für eine professionelle Entwickler

2.) Für Wartungs-Updates, reference a defect tracking Anzahl in einem Kommentar-vorausgesetzt, Sie haben eine Art von defekt-tracking-system.Dies macht es einfacher für jedermann Erhaltung Ihrer Arbeit, um herauszufinden, warum der code wurde geändert, zwischen einer überarbeitung und andere.

3.) Für Sprachen, die es unterstützen, Variablen deklarieren, so nah wie möglich an dem ersten Gebrauch.

Ich bin sicher, es gibt ein paar andere sprachunabhängige Konzepte, aber diese sind die ersten, die in den Sinn kommen.Soweit ich weiß, ist es relativ schwierig zu diskutieren coding-standards in Abwesenheit einer bestimmten Sprache.Und ich Stimme mit den anderen Antworten oben-das beste Stil ist in der Regel die eine, die meisten passt nahtlos zu den vorhandenen Stil.

Möchten Sie vielleicht werfen Sie einen Blick auf Steve McConnell ' s Code Complete.Es ist voll von guten Ideen, die sollte anwendbar sein in fast jeder Entwicklung der situation unabhängig von der Programmiersprache.

Answer 3

Konsistenz ist der Schlüssel.Schreiben Sie die Leitlinien irgendwo, und verlangen zu erfüllen.

Code-Formatierung keine sorgen machen, noch streiten über.Nur einige Regeln, und stick zu Ihnen.

Answer 4

Ich Stimme mit Joel.Es gibt viele Beispiele von Stil gibt;die meisten sind gut.Einige sind nicht so nützlich wie andere (die Ungarische notation?) mehr.Der springende Punkt ist die Konsistenz, wenn.Wie lange einen neuen Entwickler kann kommen und den code verstehen sofort, anstatt zu gewöhnen, um jede einzelne Entwickler persönlichen Stil, es funktioniert.

Switching standards jedes Jahr oder so ist wahrscheinlich eine schlechte Idee.

Answer 5

Ich Stimme mit Joel, Wartbarkeit steigt erheblich, wenn Sie Konsistenz in Ihrem Unternehmen.Wenn ich an ein anderes team der ramp-up-Zeit ist viel weniger, wenn alles hat ein ähnliches Aussehen und Gefühl zu meiner aktuellen, weil ich Lesen kann code viel schneller w/out all die "innere Zusammenhang switching" in meinen Kopf zu kriegen ", so dass Sie verwenden mVar statt _var" / etc

Answer 6

Eine der großen Anforderungen, die wir haben, ist die variable "voranstellen".Bis ich hierher kam, würde ich meist geschrieben solo so dass ich nicht sorgen über es.

Wir sind "erforderlich" name Variablen, die mit Präfixen, die zeigen, was Sie sind.So wissen Sie sofort, wenn man an dpVarName, dass es ein Zeiger auf ein double ist, und dass lVarName ist ein long int.

Ich war froh, auf den ersten, dass Sie uns zwei Möglichkeiten für Belichtungsreihen Blöcke, aber jetzt habe ich wünschte, wir waren alle nur gezwungen, es zu tun eine oder andere Weise.