Coding Guidelines: Unterschied zwischen den Versionen
Cvk (Diskussion | Beiträge) |
|||
| (5 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
| − | + | == Richtlinien == | |
Für alle PHP- und AOQML-Programmierer gelten folgende Richtlinien als '''verbindlich''': | Für alle PHP- und AOQML-Programmierer gelten folgende Richtlinien als '''verbindlich''': | ||
| + | *'''Einrückung:''' 2 Leerzeichen (keine Real-Tabs) | ||
| + | *'''Dateikodierung:''' UTF-8 ohne BOM | ||
| − | ''' | + | *'''Line Endings (Zeilenumbruchformat):''' Unix-Style (\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:<br /> | + | *'''Klammersetzung:''' [http://de.wikipedia.org/wiki/Einr%C3%BCckungsstil#Variation:_Java_.2F_Sun 1TBS (Java-Style)], also wie folgt:<br /> |
| − | <code> | + | <code xml n> |
if(bedingung) { | if(bedingung) { | ||
//... | //... | ||
| Zeile 17: | Zeile 20: | ||
</code> | </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 | ||
| − | |||
| − | + | == Anleitungen für Texteditoren == | |
| + | Natürlich ist jedem die Wahl des Editors freigestellt. Im Folgenden wollen wir kurz die Editoren [http://notepad-plus.sourceforge.net/de/site.htm notepad++] und [http://de.wikipedia.org/wiki/Kate_(KDE) Kate] vorstellen, insbesondere wie sich mit ihnen die o.g. Richtlinien einstellen lassen. | ||
| + | === notepad++ === | ||
| + | (die Bilder basieren auf der Version 5.5 des Editors):<br /> | ||
| + | <br /> | ||
| + | <br /> | ||
| + | '''Zeichenkodierung:''' Einstellungen -> Optionen... -> Neu/Öffnen/Speichern<br /> | ||
| + | [[Bild:Notepad_pp_utf8_ohne_bom.jpg]] | ||
| + | <br /> | ||
| + | <br /> | ||
| + | <br /> | ||
| + | <br /> | ||
| + | Die Zeichenkodierung der aktuellen Datei kann unten rechts eingesehen werden. "ANSI as UTF-8" steht für "UTF-8 ohne BOM".<br /> | ||
| + | [[Bild:Notepad_pp_verwendete_zeichenkodierung.jpg]] | ||
| − | |||
| + | '''Tabs:''' Einstellungen -> Optionen... -> Sprachmenü/Tabs<br /> | ||
| + | [[Bild:Notepad_pp_tabs.jpg]] | ||
| + | <br /> | ||
| + | <br /> | ||
| + | <br /> | ||
| + | <br /> | ||
| + | '''Zeilenumbruch:''' Mit dem Häkchen bei Ansicht -> Zeilenumbruch entsteht kein horizontaler Scrollbalken, wenn der Code mal zu lang wird (z.B. bei Textausgaben). Äußerst nützlich! | ||
| + | <br /> | ||
| + | <br /> | ||
| + | <br /> | ||
| + | '''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.<br /> | ||
| + | [[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]] | ||
Aktuelle Version vom 4. Juni 2017, 20:54 Uhr
Inhaltsverzeichnis
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
- Line Endings (Zeilenumbruchformat): Unix-Style (\n)
- Kommentare über PHP-Funktionen: phpdoc-kompatibel
- Klammersetzung: 1TBS (Java-Style), also wie folgt:
if(bedingung) {
//...
} else {
//...
}
- 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
Anleitungen für Texteditoren
Natürlich ist jedem die Wahl des Editors freigestellt. Im Folgenden wollen wir kurz die Editoren notepad++ und Kate vorstellen, insbesondere wie sich mit ihnen die o.g. Richtlinien einstellen lassen.
notepad++
(die Bilder basieren auf der Version 5.5 des Editors):
Zeichenkodierung: Einstellungen -> Optionen... -> Neu/Öffnen/Speichern
Die Zeichenkodierung der aktuellen Datei kann unten rechts eingesehen werden. "ANSI as UTF-8" steht für "UTF-8 ohne BOM".
Tabs: Einstellungen -> Optionen... -> Sprachmenü/Tabs
Zeilenumbruch: Mit dem Häkchen bei Ansicht -> Zeilenumbruch entsteht kein horizontaler Scrollbalken, wenn der Code mal zu lang wird (z.B. bei Textausgaben). Äußerst nützlich!
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.
Kate
Bei Kate sind die entsprechenden Einstellungen über Einstellungen / Kate einrichten und die angezeigten Untermenüs erreichbar.
Tabulatoren durch Leerzeichen ersetzen
Kodierung und Zeilenende
