[PHP] High Quality PHP-Code – Teil 1 Code-Style

[Kyôya]

1. wenn du von einheitlichen geschreiften Klammer sprichst, dann sollten die öffnenden Klammern eine Zeile hoch rutschen (class, function) oder eins runter (if).
2. bei Operatoren/Operanden hast du noch gesagt, dass es mit Leerzeichen gleich besser wird, aber das hast du in dem Beispiel wieder außer Acht gelassen (=, !==). Ich bin der Meinung, dass die Leerzeichen her sollten. Manche sind auch der Meinung, dass bei einem Cast nach der schließenden Klammer ein Leerzeichen sollte. In Java ist das Konvention, in PHP keine Ahnung.

Ok bei Punkt zwei gebe ich dir recht, da hab ich beim Schreiben ein wenig geschlampt. Danke für den Hinweis

Ich weiss ehrlich gesagt nicht, was das ganze mit 'High Quality PHP-Code' zu tun haben soll.

Das ist der Grundstein für guten PHP-Code. Weitere Spielerein kommen noch.

Hätte nicht gedacht, dass der Beitrag so gut ankommt.

Gruß Kyoya Stefan

 

[Maniac]

Da gebe ich Kyoya auch recht, ich versuche mich in meinen Projekten auch an diese Konvention zu halten.
Jedoch mache ich noch folgendes um immer zu wissen welchen Datentyp die Variable enthält:

// für ein Array
$aMyArray = array();

// für ein Object
$oMyObject = new Class();

// für einen String
$sMyString = 'Ich bin ein String';

// für einen boolean
$bMyBool = false;

// für gemischten Datentyp
$mMyMixed = array|string|object

Und natürlich sollte man auch seinen Code richtig kommentieren, da
1. die Lesbarkeit erhöht wird und man den Code schnell interpretieren kann
2. andere sich schneller einarbeiten können - man selbst noch weiß was man vor einiger zeit programmiert hat.

Damit auch IDE's und PHP-Docs die Kommentare richtig lesen können und auch dementsprechend die Codevervollständigung funktioniert sollte man auch eine einheitliche Schreibweise an den Tag legen.

 

[eifel]

Danke für das Thema "Code Style", ich halte es für wichtig, selbst wenn man "nur" für sich programmiert. Hat man den Code ein paar Monate nicht angepackt und wenig dokumentiert/kommentiert, versteht man ihn manchmal selbst nicht mehr.

Es macht auch mehr Freude "schönen" Code zu schreiben, also wenn er schon rein optisch anspricht, übersichtlich ist usw. Je konsequenter ein Stil durchgehalten wird, umso größer ist die Lesbarkeit.

Gibt es Editoren, die uns bei der Einhaltung eines Stils besonders unterstützen ?

 

[Parantatatam]

Ich glaube kaum, dass man Namen in Camel-Case besser lesen kann als mit Unterstrichen. Leider ist das ein ästhetisches Problem, was mich in PHP immer wieder ärgert, da PHP von Haus aus keine schöne Konvention hat, da Funktionen mit Unterstrichen geschrieben werden, Methoden hingegen in Camel-Case. Außerdem sieht eine Kombination aus –> oder :: mit einem Namen, der Unterstriche verwendet, immer etwas eigenartig aus, obwohl ich diese Form bevorzuge.
Wenn man sich mal Sprachen wie Ruby oder Python ansieht, dann wirkt PHP etwas unvollkommen und undurchdacht (was es wohl auch ist).

Nachtrag: Meine Skripte sehen so aus:

class DoSomethingObject
{
  #
  # @param   (object) $block: Closure
  # @return  (array):
  #
  public function get_something_from_database(Closure $block)
  {
    return $block($this);
  }
}

$new_object = new DoSomethingObject();
$new_object->get_something_from_database(function ($object)
{
  # some code ...
});

# if-then-else
if($a === $b)
{
  # ...
}
else
{
  # ...
}

# switch-case
switch($a)
{
  case 1:
    break;
  
  case 2:
    break;
}

# foreach
foreach($b as $c => $d)
{
  # ...
}

# while
while($e)
{
  # ...
}

 

[timestamp]

$z2 / 6 * 13

1. z2 druch das Produkt von 6 mal 13 oder
2. z2 druch 6 mal 13?

1

Wie in der Mathematik üblich, bei gleicher Rangfolge von links nach rechts. Also $z2 geteilt durch 6 und das dann mal 13. Ansonsten müssen Klammern her:

$z2 / (6*13)

 

[andreano]

Hallo,
erst mal Danke ! Ich bin zwar ein Anfänger, aber ich versuche seit anfang an einen "sauberen code" zu schreiben.

to Kyôya,
einige deiner Beispiele habe ich mir schon seit Anfang an angewöhnt, die anderen folgen noch.

to bn, Maniac, einfach nur crack, thombe, Yaslaw
für eure Beispiele und Hilfe kann ich mich nur von ganzen Herzen Bedanken!

Gruß Aleks