Hablando con el gran Daniel Mota (IceBeat) nos asalta una duda:
¿De que forma añadir comentarios a nuestros CSS?
Está claro que cada vez más se está separando el diseño de la estructura y que por ello se está convirtiendo en un lenguaje independiente y que debería estar comentado, lejos quedan ya aquellos <h1 style="color:red;"> a los que les sobra cualquier tipo de comentario. Ahora las estructuras complejas y que sin la posibilidad de acceder a la estructura HTML pueden hacer muy dificil de mantener.
#header {}
#header h1{
color: red;
} Está claro que sin saber que es #header, puede ser dificil mantener este código CSS. Así que viendo este código, creo que más que necesario añadir comentarios a nuestros CSS, pero ¿como?. Una pregunta no muy trivial ya que hemos de tener en cuenta que los CSS navegan hasta el cliente lo que nos limita en cuanto a tamaño se refiere, más que nada por que con según que criterios de comentarios podemos hacer que estos ocupen más que el propio código CSS. Pero por otro lado, tenemos una forma clara de saber que es cada estilo de los que estamos hablando…
Hay muchas webs que promueven el uso de comentarios en CSS y pretenden llegar a consenso global para usar la estructura Javadoc con ella:
Ejemplo
/**
* @style Standard Layout
* @media screen
* @version 1.0
* @author Franky
* @copyright Franky’s pwn comp-a-ni
* @licensor da customa
* @layout in pixels:
* | 788 |
* | 10 | 768 | 10 |
* | 10 | 27 | 741 | 10 |
*/
[...]
/**
* @section reset
* @see …
* @see http://meyerweb.com/eric/thoughts/2007/05/01/reset-reloaded/
*/
[...]
/**
* @section layout
* @todo margins an parent anpassen
*/
¿Que os parece? ¿exagerado?¿Necesario?
13 comentarios, 2 referencias
+
#