Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
de:entwickler:programmierrichtlinien [2024/11/11 17:38] – [Kommentare] grenode:entwickler:programmierrichtlinien [2024/12/02 18:21] (current) – [Kommentare] greno
Line 50: Line 50:
  
   * Wer möchte kann 1 Leerzeichen zwischen ControlKeyword (if) und der Bedingung machen, um sie von Methodenaufrufen abzugrenzen. Dies ist aber jedem selbst überlassen.   * Wer möchte kann 1 Leerzeichen zwischen ControlKeyword (if) und der Bedingung machen, um sie von Methodenaufrufen abzugrenzen. Dies ist aber jedem selbst überlassen.
-  * auch wenn nur eine Action definiert ist immer geschweifte Klammern nutzen+  * auch wenn nur eine Aktion definiert ist immer geschweifte Klammern nutzen
  
 Hier noch ein Beispiel für eine switch/case-Anweisung:  Hier noch ein Beispiel für eine switch/case-Anweisung: 
Line 87: Line 87:
  
 ===== Kommentare ===== ===== Kommentare =====
-Damit auch andere die eventuell vorhanden Bugs in eurem Code fixen können, muss dieser nicht nur übersichtlich, sondern auch verständlich sein. Daher ist der eine oder andere Kommentar unumgänglich. Hier ist der richtige Mittelweg zu wählen. Zu viel Kommentar verschränkt den Blick auf das Wesentliche (den Code), zu wenig Kommentar lässt ihn undurchdringbar erscheinen...+Damit auch andere die eventuell vorhanden Bugs in deinem Code fixen können, muss dieser nicht nur übersichtlich, sondern auch verständlich sein. Daher ist der eine oder andere Kommentar unumgänglich. Hier ist der richtige Mittelweg zu wählen. Zu viel Kommentar verschränkt den Blick auf das Wesentliche (den Code), zu wenig Kommentar lässt ihn undurchdringbar erscheinen...
  
 Kommentare sollten in der Regel in englisch erfasst werden, so dass der Sourcecode auch von nicht deutschsprachigen Entwicklern gelesen werden kann. Bei der Dokumentation von Klassen, Methoden und Funktionen verwenden wir zur Unterstützung Doxygen. Damit kann eine übersichtliche HTML-Hilfe erstellt werden. Allerdings müssen dazu ein paar Tags innerhalb des Kommentars gesetzt werden. Eine [[de:entwickler:sourcecode-dokumentation|Beschreibung zur Dokumentation mit Doxygen]] ist aber vorhanden. Kommentare sollten in der Regel in englisch erfasst werden, so dass der Sourcecode auch von nicht deutschsprachigen Entwicklern gelesen werden kann. Bei der Dokumentation von Klassen, Methoden und Funktionen verwenden wir zur Unterstützung Doxygen. Damit kann eine übersichtliche HTML-Hilfe erstellt werden. Allerdings müssen dazu ein paar Tags innerhalb des Kommentars gesetzt werden. Eine [[de:entwickler:sourcecode-dokumentation|Beschreibung zur Dokumentation mit Doxygen]] ist aber vorhanden.
Line 140: Line 140:
  
 **Variablen**\\  **Variablen**\\ 
-Variablen sollten ähnlich den Funktionsnamen im camelStyle (vielen auch als [[http://de.wikipedia.org/wiki/CamelCaps|camelCaps]] oder laOlaStyle bekannt) geschrieben werden. Globale Variablen, die systemweit gelten erhalten ein **g** als Präfix, Übergabevariablen an ein Script erhalten ein **get** bzw. **post** als Präfix, damit immer direkt klar ist, dass der Inhalt der Varialben manipuliert sein kann.\\ +Variablen sollten ähnlich den Funktionsnamen im camelStyle (vielen auch als [[http://de.wikipedia.org/wiki/CamelCaps|camelCaps]] oder laOlaStyle bekannt) geschrieben werden. Globale Variablen, die systemweit gelten erhalten ein **g** als Präfix, Übergabevariablen an ein Script erhalten ein **get** bzw. **post** als Präfix, damit immer direkt klar ist, dass der Inhalt der Variablen manipuliert sein kann.\\ 
 Beispiel: Beispiel:
  
 <code php>numberRows  // Varialbenbezeichnung <code php>numberRows  // Varialbenbezeichnung
-gCurrentUser  // globale Varialbe+gCurrentUser  // globale Variable
 getUserId  // Übergabevariable an ein Script</code> getUserId  // Übergabevariable an ein Script</code>
  
 **Konstanten**\\  **Konstanten**\\ 
-Bei Konstanten werden alle Buchstaben groß geschrieben und die einlenen Worte innerhalb de Namens durch Unterstriche getrennt.\\ +Bei Konstanten werden alle Buchstaben groß geschrieben und die einzelnen Worte innerhalb de Namens durch Unterstriche getrennt.\\ 
 Beispiel: Beispiel:
  
  • de/entwickler/programmierrichtlinien.1731343085.txt.gz
  • Last modified: 2024/11/11 17:38
  • by greno