Principii urmărite în scrierea codului

Principii urmărite în scrierea codului:
• Ușor de citit/înțeles – clar
• Ușor de modificat – structurat
• Ușor de reutilizat
• Simplu (complexitate)
• Ușor de testat
• Implementează pattern-uri pentru probleme standard

Design Patterns

Cam asa devine un proiect daca scrii cod sa mearga si intr-un final nici acela nu va mai merge :frowning:

2 Likes

de asemena as mai adauga:
scrierea comentariilor in cod conform standardelor phpdocumentor (sau similare) pentru a se putea exporta la nevoie documentatia proiectului in mod automat.

Păi așa cum zice Uncle Bob:

the only way to go fast is to go well

Am văzut zeci de cazuri de proiecte ce au avut o viteză mare la început și urma o curbă descendentă. Organizarea era spre zero, DRY era considerat un antipattern șamd.


În altă ordine de idei, aveam impresia că la facultațile de info de la noi se predau chestii învechite sau inutile. Sunt plăcut surprins să văd astfel de cursuri și mă face să iau în considerare înscrierea la o astfel de facultate :smile:

1 Like

In seara asta am avut de terminat un task pentru la munca si am inceput prin curatarea codului avand in vedere ca am lucrat mai multi si desi initial proiectul initial arata bine pe parcursul timpului s-a tranformat in ceva ca in imaginea de mai sus, intr-un final am gasit si solutia dupa refactoring to clean code, altfel m-as fii ametit mult si bine in acel cod daca nu l-as fii curatat si simplificat.

Instrumente precum PHPDocumentor pot substitui comentarea manuala a codului ori ar trebui folosite ca un plus, in caz ca…?

instrumente precum phpdocumentor genereaza documetatii pentru client sau pentru programator pe baza comentariilor si informatiilor gasite in codul respectiv (daca este comentat codul cum trebuie conform standardului). Detalii gasesti la http://www.phpdoc.org/
documentatia online de la clasa tcpdf cred ca este generata cu un astfel de soft automat (cam asa arata documentatia autogenerata)
daca insa nu se comenteaza codul (sau se comenteaza dupa ureche cu piciorul) nici un soft de generat documentatie nu va putea sa faca mare lucru.

Ma uitasem pe site si nu prea intelegeam ce face, sarisem si peste partea asta “Documentation generated by phpDocumentor 2 does not aim to be a replacement for conventional documentation but is rather supplemental, or reference, documentation.”.

Intre timp mi-a venit ideea sa ma uit pe Github cum sunt comentate si sa ma inspir de acolo.:smiley:

M-a uitam pe clean code si mi-a ramas in minte urmatorul citat:

Even bad code can function. But if code isn’t clean, it can bring a development organization to its knees. Every year, countless hours and significant resources are lost because of poorly written code. But it doesn’t have to be that way.

2 Likes