Neuentwicklung des pSys: Dokumentation

[k00ni]

Hallo,
hier folgt die Diskussion über Coding Standards, Namenskonventionen etc. aus http://www.powie.de/cms/forum/showthread.php?id=22804&from=1190541149\" rel=\"external nofollow\">diesem Thread.
 
Grüße

[k00ni]

Folgenden Stil setze ich bei unseren Projekten um. Anmerkend, bei mir ist alles in englisch, bis auf die Kommentare.
 
Funktionen:
 

function name_mit_kurzer_beschreibung ( ... ) 
{
 ...
}

 
 
Variablen:
 

$S_string = \"<--- Das ist ein String\";
$I_yeahr = 2007;
$Res_all_user = mysql_query (...); // <---MySQL-Result

 
 
Dies ist, soweit ich mich erinnern kann, die Ungarische Notation. Der Datentyp eienr Variable wird mit einem bis maximal 3 Buchstaben am Anfang hingeschrieben. Der Rest des Namens klein und verschiedene Sinneinheiten durch Unterstrich getrennt.
 
Schleifen, if-else, try-catch,...
 

if (...)
{
...
}
else
{
...
}

 
 

foreach ( $foo as $bar )
{
...
}

 
 

try
{
...
}
catch (Exception $E_exception)
{
...
}

 
 
Weiterhin setzte ich zwischen Funktionsname und erster Klammer ein Leerzeichen ( test (...) ). Strings werden bei mir immer in einfachen Klammern geschrieben, was den Vorteil hat, dass PHP dies nicht auf Variablen kontrolliert und somit etwas \"schneller\" arbeitet. Werden Variablen eingesetzt, so breche ich den String mit einem einfachen Anfürhungszeichen ab, setze einen Punkt, die Variable und mache spiegelverkehrt weiter. ( \'string\'. $S_string .\'....\' ).
 
Grüße

Das ist der erwähnte Standard-C-Stil.
BTW:

$I_yeahr = 2007; [/quote]
Year ...
Das mit den Kommentaren ist so eine Sache. Ich kommentiere nur noch englisch, da es bei Umlauten und Sonderzeichen häufig Probleme gibt, wenn man ein bestehendes Skript weiterbearbeiten möchte und dies nicht UTF-8- oder überhaupt Unicode-kodiert ist.
Bei Powies Skripten läuft dies darauf hinaus, dass ich vor jeder Bearbeitung die Skripte auf UTF-8 recode, bearbeite und dann wieder zu ISO-8859-1 recode. Sehr nerfig. UTF-8 ist einfach inzwischen Standard.

$Res_all_user = mysql_query (...); // <---MySQL-Result[/quote]
Ist allerdings missverständlich, da es einerseits Results gibt, andererseits auch Ressourcen.
Ich habe die ungarische Notation dahingehend erweitert, dass ich Datentypen kombiniere:

$AI_foo // Array of Integers, named foo (numeral array)
$HI_foo // Hash of Integers, named foo (assoc. array)
etc.