PHP, HTML, Javascript e scrittura di buone pratiche

10

Mi sono reso conto che dovevo scrivere una specifica della convenzione su HTML, JavaScript e codice PHP per me e il mio team.

Nello sviluppo web, proprio come in C ++, sono sicuramente un fan di rientri e commenti.

Tuttavia, spesso nel mio lavoro incontro codice HTML + JavaScript + PHP che improvvisamente fa venire il mal di testa.

Sto cercando di rendere il mio codice leggibile, ma ciò che sembra essere migliore per me (indentare e commentare) sembra non affascinare i miei compagni di squadra, quindi mi chiedevo se ci fosse una buona pratica o almeno condivisa quando scrivevo "ibrido "documenti proprio come le pagine Web di oggi, che giorno dopo giorno diventano sempre più complesse.

Sono consapevole del fatto che probabilmente è nella natura del codice delle pagine Web di oggi essere un po 'complicato, ma mi chiedo se esiste già una buona convenzione su questi aspetti.

— Federico Zancan
fonte

19

Seguo alcune regole generali:

Generale

I rientri sono 4 spazi.
Rientra nuovi livelli
I commenti sono <~ 80 caratteri dal livello di rientro. Se sono su due livelli (8 spazi) significa che la fermata del cursore sarà di circa 88 caratteri.
Usa commenti su più righe. Preferisco l'aspetto, tuttavia questo è un punto soggettivo .
Commenta ora piuttosto che dopo quando non hai idea di cosa stia succedendo.
Bretelle stile Allman . È più pulito ed è più leggibile. Soggettivo .

JavaScript

Usa una biblioteca. jQuery in particolare è molto buono. Elimina tutti i mal di testa del browser.
Comprendi che gli ID sono per elementi particolari, le classi sono per gli stili. Gli ID non dovrebbero essere usati più di una volta per pagina e avranno dei ganci particolari collegati. Usa le lezioni per cose come la navigazione.
Fonte in metodi. È allettante inserire tutto il codice nella bindchiamata, tuttavia metterlo nella propria funzione aumenterà la flessibilità del codice.
Utilizzare le funzioni anziché gli eval. Ciò significa setTimeout(function(){ /* Do something */ }, 1000);invece disetTimeout('doSomething', 1000);
Usa le variabili locali con var.

HTML

Markup semantico. Usa i tag appropriati. Non mettere <br />lì dentro per aggiungere spazio, regolare i margini e le regole CSS.
Tutti i tag sono in minuscolo .
Tutti i tag devono terminare con un tag di chiusura o essere autochiudenti .
Usa le classi per un layout simile. Avere un paio di classi predefinite come hide, clear, error, etc.
Tutto (script inclusi) dovrebbe entrare <head>. Preoccupati di ottimizzare (spostare le cose in giro) quando presenta un problema.
Fogli di stile esterni e sorgente JavaScript sono indispensabili a meno che non siano specifici della pagina.

PHP

I frame sono buoni, consiglio CodeIgniter.
Se non si desidera utilizzare un framework, provare a utilizzare l'ultima versione di PHP possibile. (Ciò significa 5.3).
Usa includesa tuo vantaggio.
Cancella iniezioni o usa dichiarazioni preparate.

Eseguire se i controlli sui valori preconfigurati fail-safe.

$logged_in = false;
if(check_user($user))
{
     $logged_in = true;
     $user = load_user($_SESSION);
}

Conosci la differenza tra virgolette singole e doppie. Usa virgolette singole quando possibile.
Non fare eco a HTML.

— Josh K
fonte

4

Elenco eccellente Per PHP aggiungerei 1) usa i template, non mischiare php & html (nelle applicazioni, almeno) 2) non usare include () come chiamate di funzione 3) mantieni la maggior quantità di codice al di fuori dell'ambito globale possibile.

— GrandmasterB,

chiunque raccomandi CodeIgniter e jQuery perde integrità ai miei occhi.

— Mefisto,

4

@teresko: condanna senza fornire alcuna motivazione o alternativa.

— Josh K,

+1. Un elenco di punti discutibili e discutibili, ma comunque un elenco abbastanza buono.

— Haylem,

jQuery elimina tutti i mal di testa tra browser?

— James Adam,

3

Ci sono alcune letture per l'ispirazione:

Zend Framework - stile di codifica php : Elenco di pratiche su come scrivere codice php mantenibile (formattazione di file PHP, convenzioni di denominazione, stile di codifica: array, string, classe, metodo, ad es.).
Google - guida allo stile del codice : elenco di pratiche su come scrivere codice javascript gestibile (Regole: Costanti, Punto e virgola, Funzione annidata ..., Stile di codifica: campi Nome, Ambito, Stringa, Visibilità ecc.).

— tomascejka
fonte

ti dispiacerebbe spiegare di più su ciò che fanno queste risorse e perché le consigli a rispondere alla domanda posta? Le "risposte solo al collegamento" non sono del tutto benvenute allo Stack Exchange

— moscerino

1

@gnat modifica / risposta corretta

— tomascejka

2

Tieni i 3 separati. Il codice meno gestibile con cui ho a che fare è sempre quando c'è un po 'di PHP che riecheggia molto HTML e JavaScript, probabilmente con un po' di SQL lanciato in giro per buona misura.

Mantenerli tutti separati renderà il codice molto più facile da mantenere e renderà le cose molto più snelle se ci sono persone che lavorano su diverse parti dell'applicazione, come un designer che deve solo lavorare con HTML / CSS.

— GSto
fonte

2

Il modo più semplice per codificare un'app Web PHP è sicuramente quello di unire tutto insieme. Tuttavia, finirai rapidamente con un pasticcio non mantenibile se fai le cose in quel modo.

Ecco alcune buone pratiche:

1) Inserisci il tuo JavaScript nella <head> di un documento (o, meglio ancora, in file separati a cui si fa riferimento nella testa). Scopri come associare i listener di eventi in un evento document.onload, piuttosto che disperderli attraverso il tuo html. (Meglio ancora, impara ad usare un framework come Jquery; renderà il tuo JavaScript molto, molto più carino).

2) Cerca modelli di design come MVC. Vuoi separare il più possibile la tua logica aziendale, scritta in PHP, dal tuo HTML. Idealmente, finisci per usare un bel linguaggio di template per mettere insieme le tue pagine HTML; per lo meno, il PHP nel tuo HTML dovrebbe essere conciso - principalmente chiamando variabili e scorrendo ciclicamente liste che sono costruite altrove.

3) Commenti, rientri ... che le cose sono solo le migliori pratiche di programmazione di base. Tendo a lasciare la mia lunghezza della riga superiore a 80 caratteri quando scrivo HTML, solo perché il linguaggio è così dannatamente dettagliato, ma si tratta dell'unica pratica tradizionale che dovresti lasciare scorrere - se il resto del team è sciatto, hanno bisogno di succhiarlo e modellarlo.

— toppa
fonte

Bel commento! C'è un refuso: "Inserisci il tuo JavaScript nel di un documento"

— DL

Ops. Grazie. (Ho dimenticato di codificare tra parentesi angolari. Silly me.)

— Patch

1

Javascript dovrebbe andare alla fine della tua pagina per motivi di prestazioni.

— Toby,

0

Ecco un paio di bocconcini:

Javascript: utilizzare varper inizializzare le variabili.

HTML: include gli script nella parte inferiore del file in modo che vengano caricati per ultimi.

PHP: dividi i file. Non mettere tutte le tue classi in un unico file, proprio come non faresti nel normale sviluppo di C ++. Commenta il più possibile e scrivi anche lo scopo delle tue funzioni / classi.

— Harry
fonte

Ho cercato di seguire la Guida di stile Javascript di Google: google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml

— Fosco