PHP, HTML, Javascript e buone pratiche di scrittura

Naviga le tue risposte
9

Mi sono reso conto che devo 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 decisamente un fan di indentazione e commenti.

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

Sto cercando di rendere leggibile il mio codice, ma quello che sembra essere meglio per me (per indentare e commentare) sembra non affascinare i miei compagni di squadra, quindi mi chiedevo se c'è una buona pratica migliore o almeno condivisa quando si scrivono documenti "ibridi" proprio come le pagine web di oggi, che di giorno in giorno diventano sempre più complesse.

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

    
posta Federico Zancan 05.10.2010 - 14:14
fonte

5 risposte

19

Alcune regole generali che seguo:

Generale

  • I rientri sono 4 spazi.
  • Indenta nuovi livelli
  • I commenti sono < ~ 80 caratteri dal livello di rientro. Se sono a due livelli (8 spazi) significa che il punto di arresto del cursore sarà di circa 88 caratteri.
  • Utilizza i commenti su più righe. Preferisco l'aspetto, tuttavia questo è un punto soggettivo .
  • Commenta ora piuttosto poi quando non hai idea di cosa sta succedendo.
  • parentesi graffe Allman . È più pulito ed è più leggibile. soggettiva .

JavaScript

  • Utilizza una libreria. jQuery in particolare è molto buono. Elimina tutti i mal di testa cross browser.
  • Capisci che gli ID sono per particolari elementi, le classi sono per gli stili. Gli ID non dovrebbero essere usati più di una volta per pagina e avranno ganci particolari ad essi associati. Utilizza le classi per cose come la navigazione.
  • Out source in metodi. Si è tentati di inserire tutto il codice nella chiamata bind , tuttavia inserirla nella propria funzione aumenterà la flessibilità del proprio codice.
  • Utilizza le funzioni anziché le eval. Ciò significa setTimeout(function(){ /* Do something */ }, 1000); anziché setTimeout('doSomething', 1000);
  • Utilizza le variabili locali con var .

HTML

  • Marcatura semantica. Utilizza tag appropriati. Non inserire <br /> in là per aggiungere spazio, regolare i margini e le regole CSS.
  • Tutti i tag sono in lettere minuscole .
  • Tutti i tag dovrebbero terminare con un tag di chiusura o chiudersi automaticamente .
  • Utilizza le classi per il layout che è simile. Avere un paio di classi predefinite come hide , clear , error , ecc.
  • Tutto (gli script inclusi) dovrebbero andare in <head> . Preoccupati dell'ottimizzazione (spostando le cose) quando presenta un problema.
  • I fogli di stile esterni e la fonte JavaScript sono obbligatori a meno che non siano specifici della pagina.

PHP

  • I quadri sono buoni, consiglio CodeIgniter.
  • Se non vuoi utilizzare un framework, prova a utilizzare l'ultima versione di PHP possibile. (Ciò significa 5.3).
  • Utilizza includes a tuo vantaggio.
  • Cancellare le iniezioni o utilizzare istruzioni preparate.

  • Esegui se verifica i valori preconfigurati di sicurezza fallita. 

    $logged_in = false;
if(check_user($user))
{
     $logged_in = true;
     $user = load_user($_SESSION);
}
  • Conoscere la differenza tra virgolette singole e doppie. Utilizza le virgolette singole quando possibile.
  • Non echo HTML.
risposta data 05.10.2010 - 15:22
fonte
2

Mantieni i 3 separati. Il codice meno gestibile che ho a che fare è sempre quando c'è del PHP che fa eco a molti HTML e amp; JavaScript, probabilmente con qualche SQL gettato in giro per buona misura.

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

    
risposta data 05.10.2010 - 15:22
fonte
2

Ci sono alcune letture per l'ispirazione:

  • Zend Framework - stile di codifica php : elenco di pratiche su come scrivere codice php maintable (PHP File Formatting , Convenzioni di denominazione, Stile di codifica: array, stringa, classe, metodo es.).
  • Google - guida allo stile del codice : elenco di pratiche su come scrivere codice javascript maintable (Regole: Coststans, Punto e virgola, funzione annidata ..., stile di codifica: denominazione, ambito, stringa, campi di visibilità ecc.).
risposta data 05.10.2010 - 16:03
fonte
2

Il modo più semplice per codificare un'app Web php è sicuramente quello di mescolare tutto insieme. Se si fanno le cose in questo modo, si finisce rapidamente con un pasticcio non gestibile.

Ecco alcune buone pratiche:

1) Inserisci il tuo JavaScript nella < head > di un documento (o, meglio ancora, in file separati a cui viene fatto riferimento nella testa). Scopri come associare i listener di eventi in un evento document.onload, piuttosto che disseminarli attraverso il tuo html. (Meglio ancora, impara a 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 logica aziendale, scritta in PHP, dal tuo HTML. Idealmente, si finisce per usare un bel linguaggio di template per mettere insieme le pagine HTML; per lo meno, il PHP nel tuo HTML dovrebbe essere conciso, principalmente chiamando le variabili e eseguendo il looping degli elenchi creati altrove.

3) Commenti, indentazione ... quella roba è solo delle buone pratiche di programmazione di base. Tendo a lasciare che la lunghezza della linea superi gli 80 caratteri quando sto scrivendo HTML, solo perché la lingua è così maledettamente dettagliata, ma si tratta dell'unica pratica tradizionale che dovresti lasciare scorrere - se il resto del team è sciatto, devono succhiarlo e adattarsi.

    
risposta data 05.10.2010 - 21:04
fonte
0

Ecco un paio di curiosità:

Javascript: utilizza var durante l'inizializzazione delle variabili.

HTML: includi 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 del C ++. Commenta il più possibile e annota anche lo scopo delle tue funzioni / classi.

    
risposta data 05.10.2010 - 14:24
fonte

Leggi altre domande sui tag

Quanto tempo impieghiamo a stimare le attività di programmazione? Permessi di Windows per sviluppatori?