|
L'objectiu d'aquesta pràctica és tornar a insistir com
en qualsevol curs de programació en recordar alguns aspectes de
criteris a l'hora de dissenyar un aplicatiu. No hi ha una llei establerta,
sinó experiència, i això no s'apren, es viu en la
pròpia carn.
|
|
|
|
Desenvolupament |
|
|
|
Donarem unes pinzellades sobre alguns detalls que s'han
de tenir en compte en la planificació d'un projecte, ja que és
un tema feixuc. Si us interessa el tema, trobareu molta bibliografia,
i d'autors de marcada experiència professional.
|
|
|
|
Regles |
|
|
|
Abans d'atacar temes del PHP, hem de tenir una visió més
àmplia de la programació, independenment del llenguatge
de programació que utilitzem i la plataforma que treballem.
|
 |
La planificació d'un projecte ocupa com a mínim
el 50 % del temps de desenvolupament, i aquest temps no té per què
ser proporcional a la mida del projecte. És important establir els
algorismes principals i assegurar-ne la funcionalitat, ja que així
construïm a partir de bases fiables i segures. |
|
|
|
Codificació |
|
|
|
Fàcil lectura del codi |
|
Respecte a l'estructura visual. A partir de paràgrafs,
files, columnes i espais en blanc hem d'intentar estructurar el nostre codi. |
|
Respecte a la estructura d'ordres. Hem de desgranar cada
instrucció o símbol important per facilitar-ne la comprensió. |
|
|
|
Pautes recomanades: |
|
- Utilitzar els signes de puntuació en els comentaris.
|
|
- Incloure els comentaris en diverses línies, evitar els comentaris
llargs d'una línia.
|
|
- Sagnar tots els blocs amb tabuladors.
|
|
- Deixar espais entre caràcters i paraules.
|
|
- Posar tots els comentaris de la línia en la mateixa columna
dins un bloc.
|
|
- Col·locar les etiquetes de bloc en línies separades
( <?...?>, <?php, <%....%>).
|
|
- Separar blocs diferents amb una línia en blanc.
|
|
|
|
Patrons per documentar el codi |
|
La utilització de macros per accelerar i uniformar
els comentaris, afavoreix molt el temps de creació de documentació.
Alguns editors poden emmagatzemar macros per a cada tipus de comentari i
es poden assignar a una tecla abreujada. |
|
|
|
Capçalera d'arxiu |
|
|
Nom de l'arxiu |
|
|
Descripció breu del mòdul |
(1 línia) |
|
Descripció llarga del mòdul |
|
|
Notes i advertències |
|
|
Autor |
|
|
Prerequeriments |
|
|
Post-requeriments |
|
|
Creació / Modificació |
|
|
Copyright / Llicència |
|
|
|
|
|
En cas que en un arxiu s'incorpori més d'un mòdul: |
|
|
|
Capçalera de mòdul |
|
|
Nom del mòdul |
|
|
Descripció breu del mòdul |
(1 línia) |
|
Descripció llarga del mòdul |
|
|
Llista prototip de les funcions |
|
|
Observacions i notes |
|
|
Creació / Modificació |
|
|
Prerequeriments |
|
|
Post-requeriments |
|
|
|
|
|
Capçalera de funció |
|
|
Prototip de la funció |
|
|
Descripció detallada de la funció |
|
|
Observacions i notes |
|
|
Descripció dels paràmetres d'entrada |
|
|
Descripció dels valors de retorn |
|
|
Referències globals |
|
|
Autor / Data de modificació |
|
|
|
|
|
Comentaris de línia |
|
|
|
Recordeu que quan programeu tot queda molt clar, però
amb el temps s'oblida i s'agraeixen els comentaris. |
|
Mai se n'utilitzen suficients, i només són
perillosos quan s'utilitzen tant que amaguen el codi que comenten, i quan
són estructures òbvies. |
|
|
|
Elecció de noms |
|
|
|
Noms de variables |
|
És essencial establir un criteri, ja que és
important si és una variable local o global. |
|
Pautes : |
|
- Nom de dues paraules separades:
|
|
|
|
- per majúscules ( $NomUsuari)
|
|
- Les variables globals han de tenir un prefix que les identifiqui
amb el mòdul a què pertanyen.
|
|
|
|
Noms de funcions |
|
Igual que amb les variables, és important
establir uns criteris per a la denominació de les funcions: |
|
- Evitar preposicions i conjuncions en els noms de les funcions.
|
|
- El nom ha d'estar d'acord amb les dades que esperen i retornen.
|
|
- Identificar funcions del mateix mòdul, amb un literal que les identifiqui.
|
|
- Evitar l'excés de rebuda de paràmetres i la longitud
del nom.
|
|
|
|
Disseny d'interfícies |
|
|
|
Quan dissenyem una interfície, hem de tenir
present alguns aspectes: |
|
- Quins paràmetres utilitzarem i quins necessitarem.
|
|
- Quins paràmetres es repeteixen en la majoria de les funcions
de la interfície.
|
|
- Quin ha de ser l'ordre lògic de posició dels paràmetres
que espera la funció i mantenir el criteri en tota la interfície.
|
|
|
|
Respecte a la modularitat, intenteu obtenir arxius
petits de codi font, ja que milloren el manteniment del projecte. A més,
ens facilitaran la reutilització d'aquest codi en altres aplicacions. |
|
|
|
Els arxius que creeu han de tenir un nom coherent
amb el contingut, i si pertanyen a un conjunt superior, és preferible
que portin un prefix que els identifiqui. |
|
|
|
Documentació |
|
|
 |
Hi ha disponibles a Internet alguns sistemes de
codi lliure que creen la documentació d'aplicatius per a PHP a causa
de la durada del curs; ens és impossible detallar aspectes del seu
funcionament. Com a exemple, podeu trobar un documentador anomentat DOXIGEN. |
|
|
|
A partir d'ara. |
|
|
 |
En el llistat següent hem definit una capçalera
senzilla pels nostres fitxers 'php' que es mostraran al llarg d'aquest
curs . Considerem que aquesta capçalera (les 9 primeres línies), conté
els elements essencials i mínims per identificar els fitxers que utilitzareu
en les vostres pràctiques.És per això que us demanem que qualsevol fitxer
'PHP' o 'HTM' que envieu al vostre tutor, contingui
com a mínim aquesta capçalera. |
|
|
|
Premeu damunt la icona de ' visualitzar' i veureu
el codi colorejat, per poder diferenciar les diferents parts que composen
aquest fitxer ( codi PHP, codi HTML, comentaris, instruccions PHP i instruccions
HTML ). |
|
|


|
<?php
/*-----------------------------------------------------------------
* Mòdul: 1 Pràctica: 4 Fitxer: m1p41.php
* Autor: D116 Data:
* Descripció: descripció curta del programa
* Pre condi.: condicions abans d'executar el programa
* Post cond.: condicions després d'executar el programa
-----------------------------------------------------------------*/
?>
<!doctype html public "-//W3C//DTD HTML 4.0 //EN">
<html> <head>
<title>Mòdul 1 Pràctica 41</title>
</head><body>
<?php
// *******************
// Instruccions PHP
// *******************
echo "Fitxer de mostra";
?>
</body>
</html> |
|
Llistat 1.4.1. Codi
fitxer m1p41.php |
|
|
|
|
|
|