4DEVS

   1      #### ##### #   # #        ##### ### ####    ##   #    # ###   ##
   2     #    #  #   #   # #        #    # # #    #  #  #  ##   #  #   #  #
   3     #       #   #   # #        #    # # #      #    # # #  #  #  #    #
   4      ####   #    ###  #        #####  #  ####  ###### #  # #  #  ######
   5          #  #     #   #        #      #      # #    # #   ##  #  #    #
   6     #    #  #     #   #        #      # #    # #    # #    #  #  #    #
   7      ####   #     #   ######   #     ### ####  #    # #    # ### #    #
   8
   9                 STYL PISANIA KODU WATERMELON CMS-A
  10                                                      PRAWIE GOTOWE ...
  11                       LEKTURA OBOWIĄZKOWA!
  12 ____________________________________________________________________________
  13
  14    To jest obowiązyjący dla programistów Watermelon CMS-a styl programowa-
  15    nia. Jednolity styl poprawia wygląd kodu i ułatwia jego późniejszą refa-
  16    ktoryzację. Jeśli zauważysz, że ktoś zrobił inaczej, popraw.
  17
  18    1. Wygląd kodu
  19
  20       a) Taby
  21
  22          Nie ma tabów. Zamiast tabów trzy spacje!
  23
  24       b) Klamerki
  25
  26          Typowy styl - przed i po klamerce enter.
  27
  28          if(blablabla)
  29          {
  30             test();
  31          }
  32          else
  33          {
  34             test();
  35          }
  36
  37       c) Operatory
  38
  39          Przed i po operatorze spacja.
  40
  41             $abcde = $x + ( 6 + 2 ) . 'abc';
  42
  43          Co do nawiasów - dotyczy tylko wyrażeń, czyli:
  44
  45             if(abc);
  46
  47          oraz
  48
  49             jakas_funkcja(); // nie robimy po nazwie funkcji spacji -
  50                              // według nas jest to psucie czytelności.
  51
  52          ale
  53
  54             $test = ( $a * $h ) / 2;
  55
  56          Pisanie spacji nie dotyczy operatorów zasięgu ( "::" oraz "->" )
  57
  58          Foo::Bar();
  59          $foo->bar();
  60
  61          Po przecinku zawsze spacja!
  62
  63             funkcja(6, 8, 2);
  64
  65       d) Stringi
  66
  67          Normalnie używamy do stringów apostrofów. Cudzysłowy używamy dla
  68          zapytań SQL, oraz tam gdzie to konieczne (np. "\n")
  69
  70       e) Stałe itp.
  71
  72          Stałe piszemy także dużymi literami. Stałe samego CMS-a zaczynają
  73          się od WTRMLN_
  74
  75          Stałe własnego kodu musimy poprzedzić prefiksem, aby mieć pewność,
  76          że nie będzie kolidowało z czymś innym.
  77
  78             FOO_SOMETHING
  79
  80          Pamiętamy, żeby używać stałych jeśli to NAPRAWDĘ konieczne.
  81
  82    2. Styl programowania
  83
  84       a) Pobieranie danych z DB
  85
  86          Dane z bazy danych pobieramy do obiektu. Nie pobieramy nic przez
  87          funkcję mysql_result. Ewentualnie można użyć tablicy zamiast
  88          obiektu, ale raczej preferujemy obiekty (czytelniej wygląda kod)
  89
  90          Przykład pobrania danych, które jest OK:
  91
  92             $data = $this->db->query("SELECT * FROM `test`");
  93
  94             while($item = $data->to_obj())
  95             {
  96                echo $data->text;
  97             }
  98
  99       b) Działania na tablicach
 100
 101          Jeśli chcesz przejść po wszystkich elementach tablicy użyj foreach,
 102          ponieważ jest dużo czytelniejsze od for. Ewentualnie można użyć
 103          funkcji typu array_map, ale jest to raczej mniej wygodne i mniej
 104          czytelne.
 105
 106          DOBRZE:
 107
 108             foreach($array as $item)
 109             {
 110                echo $item;
 111             }
 112
 113          ŹLE:
 114
 115             for($i = 0 ; $i < count($array) ; $i++)
 116             {
 117                echo $array[$i];
 118             }
 119
 120          Myślę, że różnica czytelności obu przykładów pokazuje, dlaczego
 121          lepiej użyć foreach ;)
 122
 123       c) Globale
 124
 125          Zdecydowanie nie używamy globali. Są dobre sposoby, aby "przeżyć"
 126          bez nich. Są to: pola (właściwości) klasy (zwykle prywatne, ale
 127          mogą też być publiczne), singleton (odradzamy), referencje itd...
 128
 129    3. Pozostałe
 130
 131       Wszystkie pliki zapisujemy z kodowaniem UTF-8 i uniksowymi enterami,
 132       tzn. \n, nie \r\n jak na windowsie.
 133
 134