Vannak nagyon jó forrás formázó eszközök, és igazából a jó programozóban ki kéne hogy alakuljon az igény a jól formázott jól dokumentált kód készítésére. Sajnos tapasztalatból tudom, hogy mikor siettetik az embert, akkor főleg a jól dokumentált rész rendesen elmarad (a legtöbb esetben nem a szándék miatt, hanem egyszerűen nincs rá idő… majd lesz rá fél év múlva mikor már egy dekát sem értesz belőle !), de valószínű a forrás formázása is hagy maga után kívánnivalót.

Tapasztalatból mondom, a rosszul formázott kód áttekintése sokkal több időbe kerül ha nem a megszokott formázást látjuk.

Forrás formázó eszközök:

0krl081115083524.jpg


Eltérés felderítő programok:
Forráskódok közötti különbségek, eltérésének felderítés vizuális segítséggel.

Java alapokon, működik szinte minden operációs rendszeren:

Windowsra és Linuxra is: apt-get install meld

A legtöbb forráskód szerkesztő program támogatja az automatikus forráskód újraformázást így az általam használt (ingyenes) Eclipse alapú Aptana vagy PDT IDE is. A forrás formázásnak a legnagyobb előnye az, hogy a kódod valamilyen szinten áttekinthető lesz.

A letölthető szkript PHPstylist osztályára épül, annyival kiegészítve, hogy Linuxon vagy Windowson parancssorban megadhatjuk neki, hogy mely mappát, milyen formázással készítse el, és ráeresztjük. A php_forras_formazo.php nem tudja rekurzívan végrehajtani ezt a műveletet (elvileg tudná), mégpedig biztonsági okok miatt. A csoportos művelet biztonságos elvégzéséhez, tapasztalt PHP programozói ismeretekre van szükségünk és konkrétan ismernünk kell az alkalmazást, hogy mit lehet és mit nem lehet formázni.

Kétféle stílus közül választhatunk amely egy picit hasonlít a K&R illetve a BSD formázásra.

A forrás formázó használata:
Másoljuk a PHP fájlunkat Linux-on a /usr/bin/ könyvtárba majd adjunk rá megfelelő jogosultságot. A formázó szkript zökkenőmentese Ubuntu Linux rendszeren fog működni (8.10; PHP5). Windows-on is működik, csak az értelmező útvonalával legyünk tisztába, illetve a Php parancssoros lehetőségeivel.

php_forras_formazo.php /var/www/

  • Ebben az esetben ledarálja az útvonalon található *.php fájlokat és elvégzi a K&R stílusú formázást majd menti *.php.formazott neven

php_forras_formazo.php /var/www/ bsd

  • a fenti csak BSD stílusban

php_forras_formazo.php /var/www/ kandr

  • a fenti csak K&R stílusban

php_forras_formazo.php /var/www/ bsd true

  • egy mappát fog létrehozni és oda másolja /var/www/.www-time()/

php_forras_formazo.php /var/www/ bsd true .lorem

  • egy mappát fog létrehozni és oda másolja /var/www/.www-time()/*.php.lorem
  • A fájlok *.php.lorem utótagot kapnak

php_forras_formazo.php /var/www/ bsd false true

  • felülírja az eredeti fájlokat adott stílussal

Help:
php_forras_formazo.php help

  • vagy böngészd a forrást


Mindenkinek jó formázást kívánok!

hasonló bejegyzés:

  1. Forrás összehasonlítás, eltérés felderítés