Главная CSS-верстка

Как вы комментируете логические блоки в разметке страницы?

В процессе верстки я постоянно стараюсь совершенствовать свои навыки. Касается это и комментариев, которыми я помечаю блоки в разметке страниц. Было время, когда я вообще ничего не комментировал в коде, но позже осознал, что с ними гораздо удобнее просматривать код, т.к. становится проще разобрать, где ...

Комментарии (40)

  1. Первый.
    Согласе, тоже так комментирую. Самый удобный и информативный вариант.

  2. Не комментирую вообще. Имен классов и нормального редактора с возможностью свертывания блоков тегов вполне хватет, чтобы разобраться даже в сложнеших страницах.

  3. Пробовал комментировать, именно таким образом (хотя без точки или хеша — только имя). Не пригодолось потом ни разу. Код лесенкой и осмысленные названия классов — уже достаточно удобно и информативно. Правда, когда разбираю чужой код, таких комментариев очень не хватает :)

    зы: Редакторы, умеющие сворачивать блоки — рулят :)

  4. Почти не комментирую. Разве что имя класса или id аналогично примеру, но без точки или решетки.
    Форматирую всегда лесенкой. Очень помогает. Иногда фолдингом пользуюсь.
    Если чужой код непонятен, то форматирую так, как удобно мне, потом разбираюсь быстро =)

  5. Я не верстальщик, но свой бложик сама собирала по кусочкам. Там кода немного, и комменты практически не нужны. Но если бы я их использовала, то ставила бы коммент в начало блока, а не в конец. Так, имхо, искать легче.

  6. всегда коментировал как попало)
    теперь буду вот так.

    [quote comment="3365"]Редакторы, умеющие сворачивать блоки — рулят :)[/quote]
    Какие наример, подскажите…

  7. Сворачивать блоки это хорошо, Но если это к примеру jsp, или такой темплейт php в котором фрагмент не имеет открывающего тега, но имеет закрывающий?

    У меня ранее были коментарии следющего содержания:

    <!-- Футрер -->
    <div>Ых</div>
    <!-- Капец Футеру -->
    

    Все разработчики ржали…

    А когда я резал КосомполитанЮа, обсуждал в коментах тамашние (рыбу) сиськи :-). Руководительницей проекта была Женщина и программеры ессесно с ней не поделились приколами и выложили это в сеть. А когда таки народная молва до нее донесла виноватым остался я!

  8. Практически так же, причем всегда — даже если я залезу в свой код через полгода чтобы что-то добавить/убрать — сразу пойму что где, экономия времени налицо! Когда много вложенных дивов, то начало блока легко найти, а вот где он закрывается… без комментариев сложно :)
    блабла, вместо слэша еще удобно использовать END — глаз лучше цепляется и визуально больше отличий «начала» от «конца»

  9. съелось, вот:
    блабла

  10. Комментарий использую только только если приходиться натягивать шаблон реализованный на smarty. Если просто верстаю то средств редактора хватает.

  11. Комментирую только окончание основных div — иногда помогает. В основном страничка бьётся на модули — «шапка», «навигация», «основной текст», «дно» — поэтому больше кодирую через php-шные инклуды (или шаблоны) — в этом случае код хорошо просматривается и без комментариев.

  12. Если блок небольшой, то особого смысла в комментировании нет. Поскольку идет левый отступ табулятором, то блок несложно отличить. Но если блок в разных файлах, то комментирование обязательно, иначе не разберешься.

    Делаю, примерно также, только в закрывающем указываю полный код открывающего:

    <div class="content-top">

    </div><!-- div class="content-top" -->

  13. Верстаю.

    Обычно комментирую только или очень большие блоки, или те блоки, которые должны иметь возможность безболезненно убраться/добавиться на разных версиях страниц, чтобы разработчикам было удобнее ориентироваться по коду.
    Делаю так:


    bla-bla-bla

  14. Комментирую и своих ребят приучаю оставлять комментарии вокруг всех ключевых блоков. Это может не касаться простеньких презентационных или рекламных сайтиков, но на больших сервисах без комментов никак не возможно — особенно, где много блоков, временно скрытых (которые показываются в зависимости от событий) и общее количество кода — несколько экранов.

    Но на строках только не экономлю. и комменты делаю парными:

  15. Код лесенкой и осмысленные названия классов — уже достаточно удобно и информативно.

    Код я делаю тоже лесенкой, но это не спасает, когда верстка натянута на движок. Если бы лесенка всегда оставалась лесенкой после обработки движком, то комментарии даже не были бы нужны, наверное.

    Правда, когда разбираю чужой код, таких комментариев очень не хватает :)

    Вот-вот. Поэтому меня спасают мои же комментарии, когда заказчик, которому я верстал, обращается ко мне через какое-то время с просьбой где-то что-то изменить. Т. е. хочу этим сказать, что станет всем удобнее и проще работать с кодом, в том числе и чужим, если в верстке будут присутствовать комменты.

    Редакторы, умеющие сворачивать блоки — рулят

    А я вот даже не представляю, честное слово, в чем полезность сворачивания =) В моем ПСпаде отродясь не было такой функции, а тестируя другие редакторы, ее имеющие, я не смог оценить ее прелести))

    Если чужой код непонятен, то форматирую так, как удобно мне, потом разбираюсь быстро =)

    Иногда мне тоже приходится так делать.

    Но если бы я их использовала, то ставила бы коммент в начало блока, а не в конец.

    Сложнее бывает закрывающийся тег найти. А о начале блока, как я уже сказал в посте, информирует либо идентификатор, либо класс. Если вы в коментарии пишите что-то типа «начала блока такого-то», тогда я вас понимаю.

    Какие наример, подскажите…

    Например, EditPlus, Notepad++, SciTE, UltraEdit-32

    Евгений, забавная история ;)

    вместо слэша еще удобно использовать END — глаз лучше цепляется и визуально больше отличий «начала» от «конца»

    Я поначалу так и делал, но потом заменил на хэш и точку. И все равно глаз цепляется хорошо — комменты же своим цветом выделены ;) sonika, с бла-бла у тебя что-то не вышло :), не забывай, что в WordPress угловые скобки нужно в аски-коде писать.

    MAX, твой вариант получается самым быстрым в плане написания коммента. Я не люблю использовать слова типа «Begin» и «End», потому что муторно писать их каждый раз, а делаю комменты копипастом — сначала горячей клавишей код комментария, а затем копирую название класса/ID. Но точку или хэш все равно приходится ставить. А у тебя еще проще — просто скопировал и вставил :)

  16. Фёдор Аксёнов
    16 лет 1 месяц назад

    Не комментирую вообще. В IE до 6-й версии включительно блок комментариев

    <!-- --->

    вносит порой дичайшие искажения рендеринга.

    Так же стараюсь не использовать special символы типа

    &nbsp; &mdash; &copy;

    в концах очень вложенных друг в друга и при этом position: relative блоках. При некоторых условиях дико тормозит рендеринг.

  17. Фёдор Аксёнов, по-моему уже давно пора забыть про IE младше 6-й версии. Пользователи таких версий живут в прошлом веке, и это их проблема, ИМХО, а не наша, разработчиков.

    Так же стараюсь не использовать special символы типа

    И как же вы, интересно, вставляете, например, символ копирайта?

  18. Тоже интересует, почему вдруг не стоит использовать

    &nbsp; &mdash; &copy;

    ?

  19. Не комментирую, только код засорять.
    Я в своем коде отлично ориентируюсь :-)
    ps. Я не верстальщик.

  20. Я вообще не комментирую свой код, т.к. работаю с ним в 99% случаев только я сам. Но твой способ мне понравился, возьму на заметку.