Документация для страниц HTML?

Question

Как мне написать хорошую документацию для страниц jhf xhtml?

Я мог бы использовать <!-- comment -->, но это сильно загромождает код и делает его иногда более нечитаемым, чем без комментариев.

Есть ли способ улучшить комментарии HTML или встроенную документацию?

Answer 1

Возможно, это не тот ответ, который вы ищете, но он может стать альтернативой массовым html-комментариям.

Я обнаружил, что гораздо проще (и логичнее) документировать методы вспомогательного компонента, чемсам xhtml.Единственное, для чего я использую html-комментарий, - это идентификация больших частей / областей на моей странице, чтобы их было легче найти.

с читаемыми и хорошо именуемыми переменными / логикой намного лучше, чем любой комментарий.