2008-11-04 6 views
17

Welchen Delphi-Codierungsstandards folgen Sie?Welchen Delphi-Codierungsstandards folgen Sie?

Unsere Firma versucht, einige bessere Codierungsstandards einzuführen, um die Lesbarkeit, Überprüfbarkeit und Wartbarkeit unseres Codes zu verbessern. Wir sind CodeGears "Object Pascal Style Guide" begegnet, aber es wurde schon eine ganze Weile nicht mehr berührt und ich kann mir vorstellen, dass einige Leute lokale Verbesserungen oder Ergänzungen vorgenommen haben. Ich bin auf einige veröffentlichte Varianten und andere Dokumente gestoßen, die ich unten aufführen werde.

NB: Ich mache nicht will einen Stil Krieg zu starten. Ich möchte nur wissen, welchen Standards Sie folgen und warum.

Danke.


UPDATE: Nun, die "JCL Delphi Sprache Style Guide" scheint der klare Sieger zu sein! Vielen Dank!

Antwort

17

JCL Delphi Sprache Style Guide

(Eine Verlängerung der CodeGear „Object Pascal Style Guide“)

http://jcl.delphi-jedi.org/documents/styleguide.html

(Danke, Jeroen Pluimers, für zu bemerken, dass der ursprüngliche borland.com Link gestorben war und für die neue Verbindung bereitgestellt wird.)

+0

Meistens folge ich nah an diesem Standard. Meine Ausnahme ist, dass ich Editierungskomponenten im Allgemeinen mit dem Präfix ed beziehe (egal, ob es ein Edit, ein Memo oder ein Kombinationsfeld ist). Für Buttons gebe ich ein Präfix mit btn. – skamradt

+2

Der Link in der Antwort funktioniert nicht mehr, aber ich denke, das ist der Artikel, den Sie meinen: http://jcl.delphi-jedi.org/documents/styleguide.html, mit diesem als eine gute zusätzliche Ressource http://jvcl.delphi-jedi.org/StyleGuide.htm –

1

JVCL-erweiterte Version von CodeGear „Object Pascal Style Guide“

(Dies sieht aus wie die JCL-Version, zu mir.)

http://jvcl.delphi-jedi.org/StyleGuide.htm

(Dank Jeroen Pluimers gehen, für die neue Verbindung bereitgestellt wird.)

2

econos - (. Untertitel „Delphi 4 Leitfaden Coding Standards Document Developer“) Coding Standard Dokument

http://www.econos.de/delphi/cs.html

+0

Ah, die guten alten Meister Xavier Pacheco, Steve Teixeira und Stefan Hoffmeister! Ich behielt die ersten beiden im Auge, aber ich frage mich, was mit Stefan passiert ist. –

0

Es spielt wirklich keine Rolle, solange Sie eine auswählen und dabei bleiben.Ein Kodierungsstandard ist wie ein Dialekt, und solange alle im Team den gleichen Dialekt sprechen, geht es Ihnen gut.

Das heißt, warum nicht den gleichen Standard wie Ihre Laufzeitbibliothek (VCL) und Dokumentation verwenden? Dann werden Sie alle den gleichen Dialekt sprechen und es wird Ihnen leichter fallen, den Code der Laufzeitbibliothek zu lesen. Und es gibt viele Codebeispiele, um Codierungskonventionen zu veranschaulichen.

+0

Das ist ein sehr guter Punkt, und ich weiß es zu schätzen, dass Sie es gemacht haben. Vielen Dank! Das heißt, wir wollen einen Standard wählen, der zur "vollständigen" Seite neigt, also ist das VCL-Dokument möglicherweise nicht das beste. –

+0

Meine persönliche Überzeugung ist, dass weniger mehr ist, und am Ende des Tages sind die Regeln, die Sie in einem Standarddokument erfassen können, für die Wartbarkeit weitaus weniger wichtig als die Einstellung und Erfahrung des Programmierers. – Jozz

0

Es kann eine Tendenz geben, Codierungsstandards so weit zu übersteuern, dass sie dem Schreiben von Code in die Quere kommen.

Ich stimme mit Jozz Kommentar. Sie können sich alle empfohlenen Standards ansehen, einen auswählen und Ihren Codierern aufzwingen oder Sie können Ihr Team in den Prozess einbeziehen.

Nach meiner Erfahrung ist der beste Weg, um ein Team zu engagieren, das Team mit der Idee und den Vorteilen der Adoption zu kommen. Ihr vorhandenes Talent ist Ihre beste Ressource. Ebenso können sie dein ultimativer Feind sein, wenn du sie auf einen Pfad zwingst, den sie nicht kaufen.

Also, nehmen Sie einen Blick auf Ihre bestehenden Kodierungsvarianten und das Team zusammen für einige lebhafte Diskussionen erhalten auf:

  • Die Gründe für einen Codierungsstandard übernehmen.
  • Wesentliche Überlegungen in der Standardisierung.
  • Auftauchen von Unsicherheiten in dem Team rund um dieses Problem.
  • Einen Punkt der Übereinstimmung finden. Was ist wichtig und was nicht?
  • Etablieren einiger Unternehmensziele, so dass jeder das Gefühl hat, auf ein gemeinsames Ziel hinzuarbeiten.
  • Lassen Sie das Team die Vorteile der Standardisierung für sich selbst verkaufen.

Das wichtigste Ziel muss sein, einen "Standard" zu etablieren, der Ihrem Team und Ihrem Unternehmen am besten dient.

0

Aus irgendeinem historischen Grund ist der Codierungsstandard bei meiner Arbeit, alle Schlüsselwörter in Großbuchstaben zu haben, sowohl in Delphi als auch in SQL. Danke Gott für die Feststelltaste.