Tom: & (PHP): Quelltext mit Tabulator oder Leerzeichen einrücken?

Beitrag lesen

Hello,

"styleguide"? Was soll das sein?
Typographic Conventions

if (is_array($trans))
{
  ?><ol style="list-style-type:lower-alpha"><?php

foreach ($trans as $x)
  {
    ?><li><?php
    echo $x[0] . ".";
    ?><ol><?php

while (list ($key, $val) = each ($x))
    {
      ?>

Auch wenn im PEAR-Standard die Schreibweise

while(...) {
      ...
      ...
  }

befürwortet wird, habe ich hier schon vielen geholfen, ihre Fehler zu finden, in dem ich als erstes ihren Quelltext umformatiert habe.

...

## bis zum bitteren Ende
  $i = 0;
  while($i < 99)
  {
    ...
    ...
  }

  • Öffendene und schließende Klammer gleicher Priorität gehören auf
      eine gemeinsame Vertikale.
  • Vor jedem Entscheidungs-, Verzweigungs- oder Schleifenblock steht
      eine Leerzeile. Die Initialisierung des Schleifenparameters steht
      nach Möglichkeit direkt vor dem Schleifenblock, anderesnfalls wird
      ein Kommentar auf den Zustand und die Herkunft des Parameters hinweisen.
  • Sequenzen werden zu Sinneinheiten geblockt
  • Vor jedem Block weist ein Kommentar auf den Sinn der Statements hin,
      auch dann, wenn zum Zeitpunkt des Codens "doch alles klar" ist.
  • Jede Variable, Konstante, Funktion die neu eingeführt wird, wird
      mittels Kommentar erläutert. Nutzen, mögliche Übernahmewerte, erwartete
      Rückgabewerte und Typen, ...
  • Keine Zeile wird länger als 75 Zeichen
  • Vor jeder Funktion steht ein optischer Trenner (Kommentar)
      #----------------------------------------------------
  • Vor dem Beginn des Hauptprogramms steht ein optischer Trenner
      #====================================================
      # main
      #====================================================
  • Vor dem Beginn des HTML-Teiles (Am Ende des PHP-Teiles) steht ein
      optischer Trenner
      #####################################################
      # HTML-output
      #####################################################

na und so weiter.

So lassen sich Scripte noch lesen und verstehen, auch wenn sie mehrere hundert kByte erreicht haben.

Liebe Grüße aus http://www.braunschweig.de

Tom

--
Fortschritt entsteht nur durch die Auseinandersetzung der Kreativen