Krok2 - Jak pisać

Z PHPEdia.pl
Skocz do: nawigacji, wyszukiwania

Szablon:TwżjStart-Top

Nim zajmiemy się tematyką specyficzną dla PHP - skupmy się przez chwilć na temacie nieco ogólniejszym. Wiele zagadnieś dotyczćcych programowania jest niezależne od używanego języka.

Pracując nad projektem, trzeba myśleć, co się robi. To bardzo ważne! "Znaj swojego wroga i nigdy go nie lekceważ!"

cdn...


Konwencje kodowania

Dla komputera na którym uruchamiamy program, nie ma wiąkszego znaczenia, jak dany kod jest sformatowany, jakie standardy nazewnictwa są w nim przyjąte, i czy jest skomentowany. Ważne, by nie zawieraś żadnych błędów.

Pod tym wzglądem umysś człowieka działał jednak zupełnie inaczej. Tekst

 przykład DZIWnie SformaTowaneGo TEKSTU, BeZ POpraWnego UżyCia WielKich LiteR  

jest znacznie trudniejszy do przeczytania, niż zdanie

 Jest to przykład poprawnie sformatowanego tekstu, z Wielkimi Literami tylko w odpowiednich miejscach 

Takich przykładów można oczywiście mnożyć - pokazują jednak, że jeśli chcemy, by nasz program nie tylko działań, ale pozwalaś również na jego wygodne rozwijanie i przeglądanie - warto dołożyć odrobiną starań podczas pisania w to, jak będzie się prezentowaś.

W tym celu przygotowane zostało wiele zestawieś Standardów Kodowania, a poniżej Chciałbym streścić pokrótce jeden z nich, przygotowany przez zespżś ludzi pracujących nad www.php.pl



STOP :)

Proszę narazie wstrzymać się z przygotowywaniem tych materiałów.

artykuł ten ma zawierać tylko streszczenie najważniejszych zasad, opartych o dokument Standardy Kodowania który jest już przygotowany (w oparciu o gśosy deweloperów php.pl) , tylko jeszcze nie wklepany.



Jak tworzyć kod łatwy do czytania

Zastosowanie odstąpów


Gdzie dodawać komentarze

Podstawowe pytanie, jak, kiedy, za co i do czego dodawać komentarze. Jak świat długi i lista programistów długa, każdy inaczej dodawaś komentarze. Ja osobiłcie proponują zastosować się do standardu phpDocumentor. Jest on prosty, czytelny, a co najważniejsze w łatwy sposób za pomocą tego standardu oraz programu zawartego na stronie Documentora można w bezproblemowy sposób wygenerować gotową dokumentację w wielu formatach gotową do choćby przekazania klientowi razem z projektem.

przykładowe zastosowanie do opisania pliku z klasą

<?php
/**
 * Opis pliku
 */
 
/**
 * Opis klasy
 */
class Klasa
{
   /**
    * Opis funkcji
    */
   function Funkcja()
   {
 
   }
}
?>

Jak nazywać zmienne

narzędzia

Wiki letter w.png To jest tylko zalążek artykułu. Jeśli możesz, rozbuduj go.