Uso dei commenti CSS
Venerdì 12 Giugno 2009 - 09:37
di Gabriele Romanato
Alcuni anni fa era stato pubblicizzato l’uso di speciali flag nei commenti CSS per facilitare la ricerca da parte degli editor testuali all’interno dei file CSS. Questi flag avevano semplicemente la forma di un segno di uguale posto immediatamente dopo l’apertura del commento. Esempio:
/*= Commento */
Possiamo aggiungere una maggiore semantica a questa tecnica usando delle lettere per marcare la funzione del commento. Per esempio, potremmo usare la seguente combinazione di lettere:
- B
- Marca un bug incontrato nel CSS che deve essere risolto.
- F
- Marca un fix per un bug.
- H
- Marca un hack.
- J
- Marca degli stili da usare in combinazione con JavaScript.
- M
- Marca una modifica apportata al CSS.
Esempi:
#extra {
float: right;
margin-right: 1em;
display: inline; /*=F Fix per il doubled margin bug */
}
h1 {
color: #393; /*=M Cambiato il colore del testo in verde */
}
Facendo così è più semplice avere una chiara idea della struttura e della semantica del nostro foglio di stile. Alla prossima!
Commenti
1
Ma a chi sarebbe rivolta questa “tecnica”?
Un CSS scritto ha bisogno di pochissimi commenti in quanto si presume che quello che lo crea sappia quello che sta inserendo.Se i commenti diventano molti, diventa anche più pesante il css per il download…
2
beh, evidentemente a chi lavora in team.
Devo dire che Textmate si adatta incredibilmente a questa filosofia, il TODO integrato alla fine… rileva esattamente tag simili in un semplici sommario ;)
3
Io consigio vivamente l’editor Leo per la gestione dei file css e xml.
Molto comodo e funzionale.
http://webpages.charter.net/ed.....front.htmlE’ un editor rivolto al literate programming ma se andate a questo tutorial: http://www.3dtree.com/ev/e/sbo.....toc_ie.htm e guardate “evira site” vi rendete contodi quanto sia comodo ed immediato.
4
@Paolo
cisco ha capito in pieno il senso del post. tieni presente che il css si può comprimere lato server e che il parsing di un CSS è forse la cosa che richiede meno tempo per un browser. ne ho discusso con Elika Etemad (HP/Mozilla Foudation) tempo fa a proposito dell’ nsCSSParser di Firefox. Lei mi ha confermato che i tempi di caricamento risentono soprattutto delle dipendenze esterne, come nei mashup.# - postato da Gabriele Romanato - 12 Giugno 2009 - 17:46
5
Utile sistema, a parte la M: molto meglio avere un sistema di versioning (come subversion o cvs) piuttosto che marcare tutte le modifiche fatte nel tempo. :)