styleguide

Jedes große Open-Source-Projekt hat seinen eigenen Styleguide: eine Reihe von (manchmal willkürlichen) Konventionen zum Schreiben von Code für dieses Projekt. Es ist viel einfacher, eine große Codebasis zu verstehen, wenn der gesamte Code in einem konsistenten Stil vorliegt.

„Style“ deckt viele Bereiche ab, von „use camelCase for variable names“ über“never use global variables“ bis hin zu „never use exceptions.“ Dieses Projekt (google / styleguide) verlinkt auf die Stilrichtlinien, die wir für Google-Code verwenden. Wenn Sie ein Projekt ändern, das bei Google entstanden ist, werden Sie möglicherweise auf diese Seite verwiesen, um die Styleguides anzuzeigen, die für dieses Projekt gelten.Dieses Projekt enthält den C ++ Style Guide, C # Style Guide, Swift Style Guide, Objective-C Style Guide, Java Style Guide, Python Style Guide, R Style Guide, Shell Style Guide, HTML/ CSS Style Guide, JavaScript Style Guide, TypeScript Style Guide, AngularJS Style Guide, Common Lisp Style Guide und Vimscript Style Guide. Dieses Projekt enthält auch cpplint, ein Tool zur Unterstützung der Einhaltung von Styleguides, und google-c-style.el, eine Emacs-Einstellungsdatei für Google Style.

Wenn Sie für Ihr Projekt ein neues XML-Dokumentformat erstellen müssen, kann der Styleguide für das XmlDocument-Format hilfreich sein. Zusätzlich zu den eigentlichen Stylerules enthält es auch Ratschläge zum Entwerfen eines eigenen vs. Anpassen eines vorhandenen Formats, zur Formatierung von XML-Instanzdokumenten und zu Elementen vs. Attributen.

Die Styleguides in diesem Projekt sind unter der CC-By 3.0 Lizenz lizenziert, die Sie ermutigt, diese Dokumente zu teilen.Siehe https://creativecommons.org/licenses/by/3.0/ für weitere Details.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.