Hauptmenü öffnen

AntamarWiki β

Änderungen

Coding Guidelines

1.525 Bytes hinzugefügt, 20:54, 4. Jun. 2017
keine Bearbeitungszusammenfassung
[[Kategorie:Mitarbeit]][[Kategorie:AOQML]]== 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ückungLine Endings (Zeilenumbruchformat):''' 2 Leerzeichen Unix-Style (keine Real-Tabs\n) [Der Editor notepad++ erlaubt die Umwandlung von Tabs in Leerzeichen während der Eingabe]
*'''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 /><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.
=== 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]]
'''Kommentare über PHP-Funktionen:''' [http://www.phpdoc.de/kongress/doccomments.html phpdoc-kompatibel]
'''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'' / 'Groß- und Kleinschreibung:'Kate einrichten''<br />und die angezeigten Untermenüs erreichbar.==== Tabulatoren durch Leerzeichen ersetzen ====Funktionsnamen immer klein geschrieben[[Bild:Kate1. Keine camelCase-Schreibweisepng]]==== Kodierung und Zeilenende ====[[Bild:Kate2. Unterstriche verwenden.<br />png]] Variablen immer klein schreiben<br />[[Kategorie:Mitarbeit]]ID-Variablen immer nach der Form[[Kategorie: $held_id, also immer "_id" am SchlussAOQML]]
3.459
Bearbeitungen