A
A
Anton2011-05-17 11:21:06
css
Anton, 2011-05-17 11:21:06

CSS+HTML Commenting: Standards, Utilities, etc?

For programming languages, it is possible to build documentation based on code comments, there are special tools and standards for writing these comments.
The question is - is there something similar for HTML / CSS?
The question is general - both links to standards / documentation rules, and links to utilities (if any exist in nature), and just your thoughts and considerations on this topic will do.
The goal is to get template and style documentation based on comments.
PS I myself am not a typesetter, so if you are a typesetter and think that the idea is crazy - also write (preferably with an explanation of the reasons)

Answer the question

In order to leave comments, you need to log in

3 answer(s)
K
kaluzhanin, 2011-05-17
@kaluzhanin

There is even a draft standard for CSS: cssdoc and its (incomplete) ruby ​​implementation: css_doc . I can’t say how much it is in demand, but logic tells me that since someone is doing this, then someone needs it.
As for HTML, I have no information, and I don’t think it’s necessary. After all, you can specify in CSS when to apply a given style, and HTML speaks for itself.

V
Vitaly, 2011-05-17
@vitstr

there was an article about cssdoc habrahabr.ru/blogs/css/87406/

A
Andrey Bilyk, 2011-05-17
@YAAP

Comment HTML - IMHO nonsense. The code must be clean. Another thing is to comment on templates (that is, so that when the page is rendered, all comments are deleted and pure HTML is shown to users)
CSS - similarly, you need to have 2 versions: 1st formatted, with comments. 2nd (working) - minimized (there are enough tools) and, if possible, compressed.
Regarding your question, I recommend reading the article Visual commenting on the layout and comments to it.
But, again, there are no standards there, there are only thoughts on how to make it more comfortable.

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question