Соглашения об HTML-комментариях - PullRequest
1 голос
/ 06 июня 2009

Мне нужно использовать комментарии HTML для хранения определенных данных, но я не хочу использовать схемы комментариев, которые уже существуют, генерируемые такими программами, как Dreamweaver <!-- #BeginLibraryItem "/File.lbi" --> или Frontpage .

Как узнать, какая схема комментариев будет наименее проблематичной или, по крайней мере, не будет похожа на другие существующие соглашения о комментариях?

PS: Мне говорят, что двойной комментарий "-" в комментариях иногда нарушает рендеринг.

Ответы [ 2 ]

3 голосов
/ 06 июня 2009

Вам нужно по крайней мере <!-- -->, чтобы иметь комментарий, и да, вы должны избегать "-" в середине комментария; «-» - фактические разделители комментариев. Кроме этого, вы можете просто поставить префикс перед любой строкой, и я думаю, что вы будете хороши - например, <!--JEREMY_RUDD: -->.

Однако сохранение данных в комментариях звучит как неоптимальная идея. Вы можете остановиться на этом? Задумывались ли вы о том, что, скажем, что-то вроде JSON не может быть более уместным?

0 голосов
/ 01 февраля 2018

Я начал стандарт, вдохновленный JSDoc и Javadoc: HTMLDoc .

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...