Esistono linee guida stabilite per la formattazione del codice nei file inclusi con riferimenti ad altri file?

Question

Esistono linee guida stabilite per la formattazione del codice nei file inclusi con riferimenti ad altri file?

#1 da (3 voti)
#2 da (1 voti)

0

Quando si sviluppa per il Web, si finirà inevitabilmente per fare riferimento a un sacco di file che alla fine verranno inclusi e combinati in un prodotto finito. Sviluppo in modo specifico molti siti Wordpress e, ad esempio, il progetto su cui sto lavorando ora include un file chiamato footer.php che contiene semplicemente questo codice:

<?php wp_footer(); ?>

</body>

</html>

Ora so che ciò che sto chiedendo è assolutamente non critico, ma mi chiedo se ci siano delle best practice consolidate per cose come l'indentazione del codice e altri problemi di formattazione all'interno dei file inclusi. Il body tag è ovviamente annidato all'interno del tag html, quindi dovresti tenere questo indentation all'interno di footer.php? Allo stesso tempo sembra strano iniziare un file rielaborando potenzialmente la prima riga di codice un sacco di volte a seconda di dove è incluso, ma potrebbe finire per creare un gran casino se si aprono molti tag nidificati in un file diverso, non tenere conto del nesting nel nuovo file, ma chiudili tutti nel nuovo file.

html coding-style

posta Roy 07.01.2015 - 12:37

fonte

2 risposte

Leggi altre domande sui tag html coding-style

Come posso (in generale) programmare un sito Web per dispositivi mobili? Comprensione del concetto di "argomenti" e "parametri"

score 3 · Answer 1

Sia in (X) HTML che in PHP, lo spazio bianco è in gran parte irrilevante e l'indentazione è utile solo per i lettori umani. Il browser che legge l'HTML e l'interprete che processa il PHP ignorerà semplicemente il rientro.

Questo fa si che la migliore pratica sia quella di provare a rendere i codici piacevoli a un lettore umano in quei file e / o output letti dagli umani su base regolare.
L'output completo della pagina non deve essere formattato in HTML, poiché sarà visto solo raramente da un essere umano.
I file che forniscono porzioni all'output della pagina devono essere formattati in modo tale che la struttura dell'HTML nel file sia perfettamente comprensibile per le persone che modificano il file. Di solito è utile se i tag di apertura e chiusura di un elemento si trovano nello stesso file (anche se i tag body e html possono essere eccezioni).

score 1 · Answer 2

Sono completamente d'accordo con Bart su questo, considerando che raramente, se mai vedrai il tuo footer.php come testo incluso nel file di referenziamento, devi solo assicurarti che footer.php sia amichevole per il lettore umano. L'unica volta che footer.php è visto come testo e non un riferimento è l'output completo della pagina nella sorgente della pagina del browser che non sarà vista dagli umani.

Quindi assicurati che ogni file sia ben formattato in modo che tu possa lavorare facilmente su di esso ma non sottolinei la formattazione tra i file di riferimento.