Hè cunsigliata forte forte di seguità ste règule à u più strettu. Stu rispettu ùn deve avè nunda à chì vede cù i vostri gusti persunali, ma permette ch’ellu si tenga u prugettu a so cuerenza è a so unità, è ch’ellu fermi sempre cusì leghjitoghju ch’ellu era in passatu. Tenite puru à mente chì altra ghjente ponu avè a pussibulità di leghje, capisce o puru mudificà u vostru còdice.
Per esempiu, vene cumuna chì e funzioni SPIP sianu scritte à l’usu a_mo_funzione(). Sterebbe dunque propriu male d’aghjunghje nuvelle funzioni scrivendu le AmoFunzione() - puru ùn essendu sta forma più da criticà ch’è quill’altra.
Detta quessa, mancu appena v’hè impedita di criticà una règula, bella sicura, o di prupone ne una più ghjusta, s’ella casca. Fate la puru, a vi prichemu, basta ch’ella sia cù ragioni.
Infine, ogni règula hà e so eccezzioni. Ma devenu esse ghjustificate da veru, altru chè da a curciàghjine di u prugrammore; è devenu esse scarse u più pussìbule. In particulare, tenite à mente chì u «pruvisoriu» à spessu tira versu u definitivu quandu chì nimu hà a voglia di mette ci e mani; eppuru vene ghjusta è lògica chì ogni prugrammore sia respunsèvule di u finazzà di u so propriu còdice, è micca di quella di l’altri.
Règule di prisentazione è di scrittura
E règule quì sottu sò cumune à un certu nùmeru di linguagi di prugrammazione: à u mìnimu, tutti i linguagi chì anu una sintassa sìmule à quella di PHP (vale à dì, in più di PHP ellu stessu, C, C++, Java....).
Di modu naturale venenu accettate ste règule, quant’è e règule di prisentazione è di tipugrafia d’un testu scrittu in linguagiu naturale; d’altronde assai ci s’assumiglianu...
Prisentazione
- U còdice deve esse bellu staccatu è indiziatu di modu à mette in valore a so struttura è e cunfine frà i diversi pezzi lògichi (in particulare e funzioni). Da staccamentu è indiziazione fatti in cundizioni deve vene capiscitoghja a struttura sùbbitu à u primu sguardu ; ma ùn devenu esse di troppu. Deve esse fatta cù cura quant’è ch’ella s’agisca d’un testu in linguagiu naturale.
- Quant’omu pò serà fatta l’indiziazione aduprendu u caràtteru tabulazione. Cusì pò omu definisce a prufundezza d’indiziazione frà i paràmetri di u so editore di testu, senza impone la à l’altri utilizatori.
- Ogni pezzu postu frà «aculate» ({}) deve esse indiziatu cù una sola tabulazione. È tira avanti è dalli, per ogni sottupezzu : Si aghjungherà una sola tabulazione à ogni livellu novu di prufundezza. Vale dinò sta règula per a dichjarazione di e funzioni.
- Ùn deve esse indiziatu u còdice ch’ùn face parte d’una funzione.
- Deve esse limitatu l’adopru di e transizioni PHP-HTML (<?php et ?>). Schisate lu propriu quandu s’agisce ghjustu di scrive pezzùculi di HTML. Rammintate vi chì un pocu è tantu di PHP inseritu à mezu à un mare di HTML ùn si ritrova mai più senza duvè fighjà da vicinu vicinu.
Tipugrafia
- Quandu si adopra parèntesi o ancini («()», «[]»), ùn ci vole micca à lascià spazi dop’à a parèntesi chì apre, nè davant’à quella chì chjode.
- Quandu si adopra uperatori binari (+, =, *, AND, ...), bisogna à lascia un spaziu da ogni latu di l’uperatore. S’ella ùn hè fatta in sta frasa, ghjè chì l’uperatori sò mintuavati è micca aduprati.
- L’uperatori unari (!, ...) devessu appiccicati à u paràmetru chì li s’appieca.
- Da cunvenuta, quandu omu chjama una funzione, ùn ci hè spaziu davant’à a parèntesi chì apre : « f($x) » invece di « f ($x) ». À l’incuntrariu, è da ch’ella sia bella diferenziata, si lascia un spaziu davanti a parèntesi quand’ellu s’agisce d’una struttura di cuntrollu integrata à u linguagiu: « if (!$x) » invece di « if(!$x) ».
- Dopu à vìrgule è punti vìrgule vene un spaziu. Invece davanti ùn li ne vene.
Règule di prugrammazione
Riflette
Prima di lampà si à prugrammà una nuvella funziunalità, fate matriculà u cerbellu...
- mètudi è algurìtimi à prò di l’implementatura :
legeri, efficaci, resistenti (fà puru unepochi càlculi da cunvalidà e scelte) ;
- adattazione à u prugettu : tramutèvule, sicuru, sòffice;
- cunseguenze par l’altre funziunalità : mudìfiche è aghjunte da fà nant’à e funziunalità esistenti ;
- postu « naturale » per sta funziunalità in u prugettu :
ch’ellu s’agisca d’interfacce, di schedari...
Ùn lasciate da cantu fatturizazione è messa in cumunu di u còdice (cù l’aiutu di e funzioni, in particulare in i schedari da include). Invece, quant’ellu si pò, schisate puru i schedari da include chì cuntenenu còdice fora di funzioni (salvu in casu ch’ella sia «naturale» è vulsuta).
Dà i nomi
- Variàbile è funzioni :
Qualessu sia u prugettu, dà nomi deve firmà robba armuniosa da ch’ellu sia leghjitoghju u còdice. Cusì, i nomi di variàbili è di funzioni cù SPIP seranu minùsculi; i nomi cumposti seranu à l’usu variabile_cumposta.
Di règula, ùn devessenu i nomi nè troppu corti, nè troppu longhi ; cusì seranu parlanti. Hè propriu d’impurtanza sta règula per e variàbili glubali, chì ponu esse sparte frà parechji schedari è tante funzioni. Per e variàbili lucale (vale à dì, à una funzione), hè più sòffice a règula. In particulare, si ponu aduprà variàbili d’una sola lèttera, per esempiu da ottene spressioni più fundute. Ramintate vi chì in ogni linguagiu di prugrammazione, unepoche di lèttere venenu accuppiate da a tradizione à certi usi (esempi : $i, $j per cuntatori di cicli, $n per fà un contu, $t per un istante o un tempu in seconde...). Ùn sviate puru micca quelle cunvenzioni chì permettenu à i vostri lettori d’esse pràticu sùbbitu.
- Schedari :
Per ragioni stòriche, i schedari da include in u spaziu pùbblicu purteranu u nome inc-schedariu.php. In u spaziu privatu, purteranu u nome ecrire/inc_schedariu.php (fate casu à u trattinu bassu invece di u trattinu nurmale). I schedari di u spaziu pùbblicu chjamati cù rinviu HTTP da u spaziu privatu portanu u nome spip_schedariu.php. Tutti l’altri schedari portanu un nome chì nè principia cù "inc", nè cù "spip".
Fà prove
Compiu qualsìasi mudìfica di primura, cunvene à pruvà la da per sè, senza aspettà chì qualchissia altru a fessi per voi. Cù SPIP, vene à verificà chì u prugrammu viaghji cum’ellu ci vole ind’è un certu nùmeru d’òspiti (per esempiu: Altern, Free...) è di cunfigurazioni (per esempiu: diverse versioni di PHP, di MySQL, diritti d’accessu à i cartulari più o menu strinti...); ma dinò chì unepoche di situazioni cumune (per esempiu in casu d’una interfaccia gràfica) sianu gestite cum’è di si deve.
Sparte e so mudìfiche
Suddesfu chè vo serete di a vostra mudìfica di u còdice, serà pò ora di parlà ne à l’altri sviluppori di SPIP, è di vede s’ellu si merita d’esse integratu in l’arburatura ufficiale di SPIP... À truvà ci in a lista di ragiunata spip-dev. À prestu !