Наглядное комментирование вёрстки

[RomAndry]

Уж лучше привычное название «TODO» сделать =)

[RomAndry]

Есть предложение: если используется шаблонизатор, то использовать тег шаблонизатора comment, тогда нет надобности парится с удалением меток — парсер просто их не выведет
к примеру в Smarty: {* this is a comment *}

[Ashot]

практически не знаком со Smarty, поясните неучу: такой комментарий не выведется в конечном коде при передаче клиенту?

[mholub]

не знаком со Smarty вообще, но ответ на ваш вопрос — да

[alisher-agzamov]

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

[keltanas]

Знаком со смарти и если продолжать мысь, то надо использовать не комментарий а блочный плагин:
{BuildTip}Some comment...{/BuildTip}
Но такой подход достаточно спорный, т.к. увеличивает нагрузку на бакенд сайта. А js-плугин выполняется только у того, кому это нужно.
Но это уже видимо история передачи макета от программиста к клиенту. И программист будет подписывать: «Это должно работать так», «А это вот так»…

[kurbik]

этак можно и руководство по пользованию сайта описывать )

[keltanas]

Шутки шутками, а например, для приложений и сервисов может быть хорошей идеей ;)

[kurbik]

Какие шутки? Как говорится — в каждой шутке только доля шутки, а остальное — правда ;)
Очень простой способ вставить комментария в скользкие моменты на сайте, хотя бы к заполнению тех же форм. А если есть возможность подогнать внешний вид комментария под дизайн сайта — вообще шикарно.

[Ashot]

внешний вид подогнать очень легко:
правится css-файл, ну и при желании можно js править на предмет разметки этих подсказок

[kurbik]

вообще супер )

а пробовали скрывать комментарий не по нажатию на крестик, а когда мыша уходит с него? имхо, удобнее будет.

[Ashot]

даже не задумался об этом, мне крестика вполне достаточно. Для вас могу соорудить и когда мыша уходит

[kurbik]

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

[Ashot]

удовлетворил вашу просьбу:
если установить флаг builtTipSettings.closeOnLeave = true; подсказки скрываются на mouseout

[kurbik]

вы быстры :)
спасибо

[Ashot]

демо-страницу и арфив так же обновил

[RomAndry]

В коде шаблонов естественно останется, хотя не сложно написать парсер который «вырежет» их, но вот в контексте естественно не будет — на сайте, в исходном коде не отобразится.

[Ashot]

в таком случае эта функция не сработает — она обрабатывается полностью на клиенте, соответственно клиенту этот комментарий должен быть отдан. для варианта, который предложили вы, нужно делать обработку на сервере

[mholub]

пишется функция от строки, которая при включенном флаге отдает коммент, а при выключенном нет.

типа buildtip(«А я коммент»)

[RomAndry]

Мне понравилась Ваша идея, но как подумал вырезать потом все, руками или парсером и коммитить обратно — жутко стало.
В простоте идея состоит в следующем (на примере PHP):
В конфиге ставим флаг, означающий «разработку»
<?php
define("BuildTip", true);
...
?>


В шаблоне:
<?php if(BuildTip) {echo '< !--{BuildTip: Классика жанра — Lorem Ipsum, ничего нового}-->';} ?>
Lorem ipsum dolor sit amet...


(убрать пробел между "<" и "!")

ну а когда сайт выходит в свет, меняем значение флага BuildTip на false ну и отключаем buildtip.js

[RomAndry]

фрагмент латинского текста из философского трактата Цицерона «О пределах добра и зла», написанного в 45 году до нашей эры

Интересный перевод от Google:
Lorem ipsum dolor = Привет мир!

так вот откуда знаменитое "Hello, world!", написанное каждым программистом, начиная с 45-года нашей эры =)

[mefcorvi]

Нужно Дэвиду Брауну написать. На самом деле там что-то в духе

[mefcorvi]

Nor again is there anyone who loves or pursues or desires to obtain pain of itself, because it is pain, but because occasionally circumstances occur in which toil and pain can procure him some great pleasure. To take a trivial example, which of us ever undertakes laborious physical exercise, except to obtain some advantage from it? But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?
Если верить www.lipsum.com/

[svistiboshka]

поправьте грамматику в заголовке

[Hellcunt]

habrahabr.ru/blogs/google_chrome/115852/

[Ashot]

спасибо, поправил. что-то слишком много у меня ошибок было :)

[plastic]

Спасибо, попробуем.

Из критичного, на вскидку, ввиду единственной возможности закрытия тултипа только по крестику, эффективность использования данного приема заметно снижается в случаях, когда тултип уходит за видимую часть окна браузера (например, у элемента расположенного в правом краю). Возможно стоит допилить проверку для корректного позиционирования в таких случаях.

[Ashot]

в попыхах даже не подумал об умном позиционировании. спасибо, внёс изменения

[Nodge]

Сейчас как раз разрабатываю нечто похожее, только в виде расширения для Chrome и сохраняющиеся на сервере.
Однако я больше делаю заметки и todo лист прямо на сайте, но комментарии к коду — клевая идея.
Спасибо за статью.

[Nodge]

Стрелку на картинке пока сам дорисовал, но хочу сделать встроенную рисовалку на канве :)

[alisher-agzamov]

Мне нравится, спасибо. Понравилось то, каким методом оставляются комментарии в коде.
p.s. Сколько работаю, мне ни разу верстальщики не оставляли комментариев.

[drzerg]

Для удаленной работы пригодится. Спасибо!

[trurl123]

В заголовке делать ошибку — это уж слишком комМЕТИрование?

[GreatRash]

Все-таки непонятно чем это лучше обычных комментариев в коде. Программер же все равно в код смотрит…

[Ashot]

код смотрит, только с ходу глядя в код, он не поймёт к какому блоку это относится (в смысле визуально).
код кодом, а когда наглядно оно всегда лучше

[bO_oblik]

У меня разрыв шаблона, комментарии от верстальщика программисту, за всю мою практику было только наоборот.

[kurbik]

Да, есть такое.
Обычно верстальщику уходило задание от разработчика, который уточнял этому самому верстальщику ньюансы отображения.

[Mupinc]

Возникает ограничение — невозможность использования последовательности двух минусов в тексте комментария (ссылка на спеку)

[Spree]

Совсем недавно Битрикс выпустил чем-то похожую, очень удобную штуку: www.bxdev.ru/posts/services/stickers/

[rrud]

А?

[kurbik]

Причина по которой вы предлагаете использовать — мне не приходилось сталкиваться, т.к. обычно от разработчика уходят требования к верстке. Зато…
Идея интересная, эти комментарии можно использовать на этапе проектирования и показывания предполагаемой страницы/функционала клиенту. Или же готовой верстки, в которую надо вшить объясняющий моменты для заказчика.

Спасибо за работу, спасибо за скрипт :)