Wie über die akzeptierte Codierung Arten, um herauszufinden,

https://stackoverflow.com/questions/232975

04-07-2019
|

Frage

Wo lesen Sie auf (die Best-Practice-in) Quellcodeformatierung, für einzelne Sprachen, dh was die Konventionen sind für Variablen etc. zur Vertiefung der Benennung und wo Klammern zu setzen, wie und wo Kommentare zu schließen, usw.

Zum Beispiel für C Kernighan und Ritchie Buch Die Programmiersprache C und Linus Torvalds' Linux-Kernel-Codierung Styleguide oder C ++ Style Guide von Google und für Perl mindestens perlstyle - Führer Perl-Stil.

Edit:. Vielleicht sollte ich gefragt: „Wie mit Codierung Stil einen guten Start bekommen“

Lösung

Ich würde nicht zu viel geben auf solche Art-Guides. Sie sind ein guter Anfang, aber am Ende Sie oder Ihr Team eigene Codierung-Designs entwickeln.

EDIT:. Rob Kommt eine Bemerkung gemacht, dass er mehr über diese ‚Start Konventionen‘ finden will out

Das ist ein guter Punkt. Aber vor allem werden Sie bestehende Projekte beitreten, Open-Source-Projekte oder kommerziell, und die Leute arbeiten daran bereits einen Code-Konvention haben. In einem Unternehmen wahrscheinlich existiert bereits eine Code-Konvention. Wenn Sie ein neues Projekt beginnen, mit den Konventionen eines anderen Projektes beginnt zuvor.

Wenn Sie wirklich ein neues Projekt mit einer neuen Sprache beginnen Sie noch nie benutzt haben ... dann könnten Sie mit Konventionen einer anderen Sprache beginnen, die irgendwie ähnlich ist (dh für eine neue oo-Sprache Konventionen von Java verwenden können oder Smalltalk) und Ihre Konventionen anpassen, wie Sie Erfahrung für die neue Sprache zu gewinnen. Als ich Programmierung in Java gestartet habe ich meine Pascal-Codierung-Konventionen. Einige der pascal-Konventionen nicht funktioniert sehr gut für Java, aber mit der Zeit ließ ich einige alte Konventionen und entwickelt neue.

hatte S.Lott die Idee zu schauen in ein Open-Source-Projekt in der Sprache Ihrer Wahl geschrieben. Das ist eine gute Idee, einige Vorschläge über gute Konventionen zu erhalten. Srikanth hatte die gute Idee für eine gute Konventionen hier bei Stackoverflow zu fragen. Eine sehr gute Idee, denn mit der Zeit wird auf diese Weise Stackoverflow eine gute Referenz für die Codierung-Konventionen wird.

Andere Tipps

Was ist besser als ein Buch ist Open-Source-Code in Ihrer bevorzugten Sprache zu suchen.

Anstatt ein Buch - das Werk einiger weniger Autoren und Herausgeber -. Quellcode arbeiten, ist ein Gemeinschaftsprojekt, das Gemeinschaftsstandards hoch entwickelte erfüllt

Wenn vom Kunden gefragt, mit Coding-Standards zu helfen, ziehe ich ein gutes Open-Source-Projekt zu finden und ein kurzes Standarddokument zur Verfügung stellen, der sagt „es wie xxx aussehen“. Ein gutes Beispiel dafür, dass ich für Java-Stil verwenden, ist der Apache Ant Projekt.

Jeder hat seine Lieblings Open-Source-Beispielprojekt. Lesen Sie einige der realen Welt, Code zu arbeiten, und einen Favoriten auswählen. Emulieren das Projekt.

Ich würde die Verwendung von Google für sie. Zum Beispiel für Java Coding-Richtlinien zu suchen, ich werde verwenden diese Abfrage oder per Post in Stack-Überlauf und fragen, was sind die für Java-Codierung Standardrichtlinien recommeded. Es ist schwierig, auf eine einzige Quelle für alle Sprachen zu zeigen.

Ich würde vorschlagen, dass Sie eine für Ihr Unternehmen / Projekt wählen und bleiben Sie dabei und stellen Sie sicher, es ist ein guter Standard.

Ich würde wirklich empfehlen Onkel Bobs Clean Code zu lesen wenn Sie besorgt über Code-Stil Themen.

Es gibt drei gute Plätze zu suchen.

Beliebte Bücher über die Sprache, die Sie verwenden.
Open Source Projekte in Ihrer Sprache verfasst.
Check-Typ-Dienstprogramme für Ihre Sprache.

Wenn Sie ein Tool wie Check oder PMD verwenden, beachten Sie, dass viele der „Regeln“ sie erzwingen kann umstritten sein. Es könnte hilfreich sein, um zu überprüfen, um herauszufinden, welche vorsichtig sein, regiert.

Microsoft hat ein Referenzdokument mit ihren Codierungskonventionen, die nützlich sein können, zu sehen, auch wenn Sie nicht mit C #. Darüber hinaus Stil und grundlegenden Konventionen, Best Practices Bücher von anderen hier empfohlenen wie Clean Code sind eine wichtige Lektüre wartbar, lesbaren Code für die Erstellung, die Sinn für zukünftige Maintainer Ihrer Code-Basis machen.

Wenn Sie Visual Studio verwenden (und einige andere moderne IDEs), grundlegende Unstimmigkeiten mit dem empfohlenen Konventionen sind unterstrichen automatisch (mit Vorschlägen auf schweben in neueren Versionen von VS). In VS, wenn Ihr Team will verschiedene Standards verwenden, öffnen Sie einfach die Projekteigenschaften und Ändern von Einstellungen für „Code-Analyse“ (letzter Punkt im Menü links). Mehr hier: Regelsätze verwenden, um Gruppencodeanalyse-Regeln

Hallo und guten Tag für alle

Nun, ich muss sagen, dass es hängt Es hängt davon ab, ob Sie für ein Unternehmen arbeiten oder wenn Sie arbeiten für Sie;)

Wenn Sie für ein Unternehmen arbeiten, mus man die Namensgebung Stil und andere Regeln akzeptiert

und für Sie, müssen Sie nur einen Stil schaffen, dass jeder mit sich selbst kann sofort verstehen, was und wie

die Klammern und andere sind Ihre Art und Weise

aber wie Sie gesagt gibt es einzelne Sprachen, so dass sie eigene Regeln haben

und wie Mnementh sagte jedes Team eine Möglichkeit haben, vielleicht zu Codierung schränkte oder freie Art und Weise

Das ist alles mit nicht mehr .... bye bye

Es ist der C und C ++ Style Guides , eine kurze Seite mit Links In dem Styleguides, Codierungsregeln und Diskussionen von USENET, verwaltet von Christopher Lott.

Wenn Sie ein PHP Entwickler diese beiden Führungen sind nicht zu übersehen:

Lizenziert unter: CC-BY-SA mit Zuschreibung

Nicht verbunden mit StackOverflow