Versiune printabilă
Pentru cei care stiu PHP sau care vor sa invete, luati si cititi daca nu vreti sa va dati pumni in cap mai tarziu ca nu ati scris codul cum trebuie: phpBB Coding Guidelines - un set de reguli pentru a scrie cod inteligibil, atat pentru voi cat si pentru altii care vor citi codul vostru (aviz fanilor open-source ;)).
Spor la codat!
Din cate stiu erau niste pdf-uri care spuneau totul despre coding, nu cu referire la php, dar reguli si sfaturi care se pot aplica in orice limbaj de programare .... o sa le caut si o sa le postez aici...
PS: e misto linkul de mai sus
E misto documentu'... Nu pot sa le zic phpistilor amatori decat sa puna mausu' pe el si sa il citeasca. Dar te rog, tine-l intr-un singur thread, ok? Nu vreau sa fiu enervant, da daca ajungeti toti ca mine si postati aiurea (;) Razvan), facem forumul varza, si e pacat.
Merci inca odata,
Andrei
Fiecare firma/organizatie/grupare care produce soft, tinde sa impuna un coding style ca fiind cel mai bun. Firmele la care am lucrat, au avut parteneri in n-shpe tari... fiecare cu stilul lor intern in programare. Intr-adevar exista anumite tehnici ce ajuta la maintenanta codului, fie el in C++, Java, C# sau Php. Mult mai important este insa sa pastrezi acelasi coding style in tot proiectul. Chiar si la proiectele mici.
Cand va apucati de un proiect, nu cautati un coding style de la altcineva, decat daca sunteti la inceput sau daca acel cineva este "CINEVA" in domeniu. Vezi sun pe partea de java... sau JetBrains.
Faceti-va voi un scurt document cu conventii de denumire, tab-ulare, comentarii etc. Va ia o ora maxim sa puneti intr-un fisier tot ce va trece prin cap referitor la cum vreti sa arate codul. Urmatorul pas e sa respectati acele conventii in toate clasele/fisierele scrise de voi. Daca aplicatia permite altora sa dezvolte module, atunci faceti public acel fisier, si asigurati-va ca totul este respectat.
Vorbind de asta, mi-am amintit de o regula de coding, impusa de Funambol, si anume sa nu se foloseasca tab-uri pentru identare ci space-uri. Initial mi s-a parut o tampenie, insa mai apoi am realizat ca de fapt e o treaba faina... dar mai greu de respectat. Voi ce parere aveti?
Citat:
Originally posted by WeaselMan
[b]Pentru cei care stiu PHP sau care vor sa invete, luati si cititi daca nu vreti sa va dati pumni in cap mai tarziu ca nu ati scris codul cum trebuie: phpBB Coding Guidelines - un set de reguli pentru a scrie cod inteligibil, atat pentru voi cat si pentru altii care vor citi codul vostru (aviz fanilor open-source ;)).
Spor la codat!
Woa... sa dau space nu TAB? De ce?
Funambol sta in spatele la Sync4J. Sync4J e un proiect Open Source. Un proiect Open Source e dezvoltat de catre sute de dezvoltatori, fiecare lucrand pe platforme diferite si in medii de dezvoltare diferite. Acuma gandeste-te la modul in care fiecare editor afiseaza textul. Un simplu fisier php, arata diferit in notepad, context, ultra edit sau macromedia dreamweaver. Asta din cauza tab-urilor.
Asa-i ca acuma nu ti se mai pare asa de nasoala ideea?
Citat:
Originally posted by Razvan Pop
[b]Woa... sa dau space nu TAB? De ce?
Hmmm... sper sa nu fac niciodata un proiect Open Source cu sute de dezvoltatori. :)
Nu se stie niciodata.
Citat:
Originally posted by Razvan Pop
[b]Hmmm... sper sa nu fac niciodata un proiect Open Source cu sute de dezvoltatori. :)
intr-adevar, ai dreptate. dar majoritatea editoarelor au si optiunea sa-ti setezi tu dimensiunea tabului.Citat:
Originally posted by ITE
[b]Funambol sta in spatele la Sync4J. Sync4J e un proiect Open Source. Un proiect Open Source e dezvoltat de catre sute de dezvoltatori, fiecare lucrand pe platforme diferite si in medii de dezvoltare diferite. Acuma gandeste-te la modul in care fiecare editor afiseaza textul. Un simplu fisier php, arata diferit in notepad, context, ultra edit sau macromedia dreamweaver. Asta din cauza tab-urilor.
Asa-i ca acuma nu ti se mai pare asa de nasoala ideea?
Intr-o vreme editorul meu preferat era notepad... si ala nu avea ;)...
Sau editoare in mod text din linux... ca mai sunt si din astia... :)
Citat:
Originally posted by phane
[b]
intr-adevar, ai dreptate. dar majoritatea editoarelor au si optiunea sa-ti setezi tu dimensiunea tabului.
Mi-am adus aminte cand ti-am spus tie despre el si am zis sa-l postez aici intr-un nou thread ca sa fie gasit mai usor de catre amatori ;) Se pare ca am intuit bine.Citat:
Originally posted by andypopa
[b]E misto documentu'... Nu pot sa le zic phpistilor amatori decat sa puna mausu' pe el si sa il citeasca. Dar te rog, tine-l intr-un singur thread, ok? Nu vreau sa fiu enervant, da daca ajungeti toti ca mine si postati aiurea (;) Razvan), facem forumul varza, si e pacat.
Merci inca odata,
Andrei
In alta ordine de idei, stilul asta de cod mi se pare cel mai clar si usor de folosit de catre toata lumea, desi uneori e atat de "aerisit", incat e la fel de greu sa gasesti ceva ca si cum ar fii fara spatii intre instructiuni. :shock:
In plus, orice incepator in PHP va da de phpBB mai devreme sau mai tarziu, si cred ca e un standard destul de bun pentru orice script PHP, iar stilul lor de lucru este foarte bun.
In primul rand respect lui ITE pentru post-uri, care sunt chiar de citit. Pe bune. Ai zis niste chestii foarte inteligente.
In al 2lea, bai weasel... Eu nusht de ce te mai laud ma pe tine... dupa ce imi insulti codu'. Sunt de-a dreptu revoltat... :) Acum, mi-am schimbat oleaca parerea, si intreb asa... Dom'le, daca eu inteleg codul, si eu consider ca este suficient de aerisit si etc etc etc, de ce sa il modific, cand nu mai lucreaza nimeni pe el... Ma enerveaza faptul ca asta ia timp stii... tu stai sa apesi pe spacebar de exact n ori de ex? eu nu... graba o fi stricand treaba dar si banii circula cand pui acolade...
Daca imi dati niste motive bune sa scriu codul dupa niste guidelinuri, atunci ok, dar altfel nu vad de ce...
Scopul meu este de a minimiza munca de sclav cu loopuri, fctii s.a.m.d.
Why bother?
Respectele mele inca odata pentru ITE,
Andrei Popa
Pai dude... incepusem si eu ca tine, dar dupa vreo 2 ore mi-am dat seama ca nu e bine :D
Ti-am zis motivele mai sus; daca incerci sa te uiti peste niste cod de acuma 1 luna sau ceva, nu prea o sa intelegi mare lucru din el :)
Pentru asta s-au inventat comentariile in cod si documentele de specificatie (Prd, Frd, Tech Specs)
Citat:
Originally posted by WeaselMan
[b]Pai dude... incepusem si eu ca tine, dar dupa vreo 2 ore mi-am dat seama ca nu e bine :D
Ti-am zis motivele mai sus; daca incerci sa te uiti peste niste cod de acuma 1 luna sau ceva, nu prea o sa intelegi mare lucru din el :)
Ma omule, codu' merge... Nu mai ai pe nimeni sa te injure (alt developer care lucreaza la ac. proiect) ca il scrii fara acolada la 3 spatii si il scrii pe acelasi rand cu acolada. Nu mi s-a intamplat NICIODATA sa nu inteleg propriul meu cod.Citat:
Originally posted by WeaselMan
[b]Pai dude... incepusem si eu ca tine, dar dupa vreo 2 ore mi-am dat seama ca nu e bine :D
Ti-am zis motivele mai sus; daca incerci sa te uiti peste niste cod de acuma 1 luna sau ceva, nu prea o sa intelegi mare lucru din el :)
Singura data, aveam un cod scris urat in C++ si nu intelegeam nimic...
Atunci am invatat sa pun comentarii...
Nu o sa mearga mai repede, nu o sa fie mai frumos designul, nu o sa scrie mai frumos cand da cineva pe view source...
Concluzia este: nu te mai lega de codul meu deoarece vine si il rupe in bataie pe codu tau!!! 8)
Respect,
Popa
php coding guidelines pe care eu il am la favorites. nu mai stiu de cine era recomadat dar probabil ca l-am gasit pe zend, devshed.... pe unde mai intram.
pagina originala era la utvikler.start.no/code/php_coding_standard.html dar vada ca s-a mutat....
Cam toate aspectele legate de formatarea codului sunt motive de jihad: am vazut odata o cearta pe un forum legata de locul unde se pun acoladele si numarul de newlines dintre ele si restul codului: unii ziceau "cu cat mai multe, cu atat mai bine, e mai lizibil", altii intrebau cum naiba e mai lizibil
decatCod:
if ( a > b )
{
if ( c = d )
{
ceva;
}
else
{
altceva;
}
}
Pe tema asta pornesc de obicei flame-uri uriase, noroc ca pe aci nu prea sunt programatori "batrani". Eu lucrez in C++, PHP, cateodata Javascript, Python, Perl, foarte rar Java, si am vazut multe stiluri de coding, exista si programe care te ajuta la asa ceva (cine foloseste linux probabil ca a auzit de indent si astyle, ultimul fiind implementat si ca plugin pentru jEdit).Cod:
if ( a > b ) {
if ( c = d ) {
ceva;
} else {
altceva;
}
}
In cativa ani de programare am ajuns sa-mi formez stilul propriu, pe care il folosesc cam peste tot unde sintaxa e C-like (adica tot in afara de Python), stil inspirat si foarte asemanator cu http://root.cern.ch/root/Conventions.html (partea cu coding style e mai pe la final), mi se pare un stil suficient de aerisit pentru a fi lizibil, si care nu face risipa de spatiu (nu toata lumea are monitoare >= 19" ca sa stea in 1600x1200). Un stil de coding aproape identic folosesc si cei de la Drupal ( http://drupal.org/node/318 ), spre deosebire de mine ei prefera spatiile si dau enter inainte de "else".
Si ca veni vorba de softuri PHP: phpBB e, intr-adevar, un bun exemplu de dat incepatorilor, de genul "asa nu", vezi istoria de bug-uri dragute pe care le-a avut. Guideline-urile lor tin partial de common sense (spatii in expresii), partial de sintaxa corecta (fazele cu array-urile asociative si isset), care iar tine de common sense, si a load of crap de genul ghilimelelor si a fazelor gen "ba, e bine ca mine si altfel nu". Documentul dat de lixor suna mult mai profesionist, e mai bine structurat, asa ca il recomand cu caldura.
P.S. O lectura interesanta legata de coding standards: http://www.freevbcode.com/ShowCode.Asp?ID=2547