Änderungen

← Zum vorherigen Versionsunterschied

Coding Guidelines

323 Bytes hinzugefügt, 20:54, 4. Jun. 2017

keine Bearbeitungszusammenfassung

~~[[Kategorie:Mitarbeit]][[Kategorie:AOQML]]~~ = ~~Coding Guidelines~~ =Richtlinien ==

Für alle PHP- und AOQML-Programmierer gelten folgende Richtlinien als '''verbindlich''':

*'''Einrückung:''' 2 Leerzeichen (keine Real-Tabs)

*'''Dateikodierung:''' UTF-8 ohne BOM

*'''~~Einrückung~~Line Endings (Zeilenumbruchformat):''' ~~2 Leerzeichen~~ Unix-Style (~~keine Real-Tabs~~\n)

*'''Kommentare über PHP-Funktionen:''' [http://www.phpdoc.de/kongress/doccomments.html phpdoc-kompatibel]

*'''Klammersetzung:''' [http://de.wikipedia.org/wiki/Einr%C3%BCckungsstil#Variation:_Java_.2F_Sun 1TBS (Java-Style)], also wie folgt: <codexml n>

if(bedingung) {

//...

</code>

*'''Groß- und Kleinschreibung:'''

**Funktionsnamen immer klein geschrieben. Keine camelCase-Schreibweise. Unterstriche verwenden.

**Variablen immer klein schreiben

**ID-Variablen immer nach der Form: $held_id, also immer "_id" am Schluss

~~'''Dateikodierung:''' UTF-8 ohne BOM~~

~~'''Line Endings (Zeilenumbruchformat)~~== Anleitungen für Texteditoren ==Natürlich ist jedem die Wahl des Editors freigestellt. Im Folgenden wollen wir kurz die Editoren [http:~~''' Unix~~//notepad-~~Style~~ plus.sourceforge.net/de/site.htm notepad++] und [http://de.wikipedia.org/wiki/Kate_(\nKDE)Kate] vorstellen, insbesondere wie sich mit ihnen die o.g. Richtlinien einstellen lassen.

~~'''Kommentare über PHP-Funktionen:''' [http://www.phpdoc.de/kongress/doccomments.html phpdoc-kompatibel]~~ ~~'''Groß- und Kleinschreibung:''' Funktionsnamen immer klein geschrieben. Keine camelCase-Schreibweise. Unterstriche verwenden. Variablen immer klein schreiben ID-Variablen immer nach der Form: $held_id, also immer "_id" am Schluss~~ = ~~Tipps zum Umgang mit dem Editor~~ == notepad++ === Natürlich ist jedem die Wahl des Editors freigestellt. Im Folgenden wollen wir kurz den Editor [http://notepad-plus.sourceforge.net/de/site.htm notepad++] vorstellen, insbesondere wie sich mit ihm die o.g. Richtlinien einstellen lassen (die Bilder basieren auf der Version 5.5 des Editors):

'''Einrückungen zurück nehmen (Text nach links verschieben):''' Es kommt öfter vor, dass der Text zu weit eingerückt wurde. Um ihn wieder nach links zu rücken, kann dies mit SHIFT+TAB geschehen.

[[Bild:Notepad_pp_tabs_zurueck.jpg]]

=== Kate ===

Bei Kate sind die entsprechenden Einstellungen über ''Einstellungen'' / ''Kate einrichten'' und die angezeigten Untermenüs erreichbar.

==== Tabulatoren durch Leerzeichen ersetzen ====

[[Bild:Kate1.png]]

==== Kodierung und Zeilenende ====

[[Bild:Kate2.png]]

[[Kategorie:Mitarbeit]]

[[Kategorie:AOQML]]

Cvk

Bürokraten, Administratoren

3.459

Bearbeitungen

AntamarWiki β

Änderungen

Coding Guidelines

AntamarWiki ^β