что через пару лет этот код не будет поддерживать любитель vim/emacs, например
лично я думаю, что он будет только безумно счастлив увидев хорошо оформленный рисунок, который возможно объяснит ему всё гораздо лучше, чем сухой абстрактный комментарий.
Я хочу быть правильно понятым и не настаиваю на своём стиле комментирования, но надеюсь, что вы согласитесь, что написать хороший комментарий бывает ничуть не проще написания хорошего кода, а так же сделать хорошую картинку и скриншот тоже бывает очень не просто. Но я считаю, что на сегодняшний день отсутствие комментов в виде картинок не позволяет выйти комментированию на качественно новый уровень.
Да и за то время, которое уходит на снятие скриншота и прописывание урла
Вот! И это одна из главных проблем создания таких комментариев. Однако, это не значит, что этот недостаток нельзя преодолеть. Разве нет? Вот есть плагин "Image Comments", есть плагин "MarkDown Editor". Если их функции объединить (а эти плагины open source), то время на прописывание url-ов уже становится незначительным и его можно не брать в расчёт. (вставка картинки по Ctrl-V в любом месте кода)
Я писал как-то плагин отображения при наведении мышкой, не понравилось. Лучше поставить мелкий масштаб и если что, то смотреть уже при наведении мышкой. А то не видно, что картинка вообще есть. Но это дело вкуса. Вас же никто не обязывает вставлять картинку. Просто лично мне нравится, что картинка вообще есть. На поддержку программы сильно влияет. Забудете через полгода, что и как, а тут и картиночка имеется. Текст не всегда отражает суть, тем более, что контекст может сильно поменяться, а так хоть видно, что GUI изменился.
У меня на поддержке около десятка программ, и всякие плагины. Очень помогает.
На счёт параметров — согласен. Но это не мои. Из другой системы приходит, так что уж как есть. Хорошо ещё с регистрами договорились.
Конечно, опыт реальный. За основу брал плагин: https://marketplace.visualstudio.com/items?itemName=MsBishop.ImageComments
Пришлось его немного допилить, чтобы можно было copy-paste картинок делать, но даже в том виде, в каком он есть уже комфортнее работать. Есть у меня прога обхода принтеров и снятия с них показаний. Типов 30. На каждый принтер надо было указать из какого места что снимать. Вот такие картинки уже удобнее освежать в памяти:
Если что, вот ещё интересный плагин для readme.md под Visual Studio: https://github.com/madskristensen/MarkdownEditor
И как-то на пару они хорошо дополняют друг друга. Один в коде картинки показывает, в другом readme удобно писать. Почти лепота. )
А мне ещё вот такая штука понравилась, когда можно картинки прямо в код вставлять. Всё проще читать, когда уже не вспомнить что на что влияет, например, в интерфейсе:
Честно говоря я не очень понимаю, как считаются 90%? Все установленные программы по количеству или на один комп? Поэтому во-первых, всегда можно сказать, что такое ПО идёт в остальные 10%. А во-вторых — так же не ясно, что речь идёт только о рабочих станциях или о серверах тоже? Неясно. Так же программа может предоставлять услуги как web-сервис и не находится в организации, поэтому может вообще «не считаться» в процентах никак. Тут как быть? В общем — может забить и забыть?
Ну нет! Позвольте, так это всё, что выше оказывается технический долг? Я так работать не согласен! Шучу, конечно. Но в программе же наоборот есть места, которые уж точно делать не надо! Не нужно же всё заполнять, чтобы пустот не было!? Может что-то надо оставить пустым? )))
Вы пытаетесь убедить меня или браузер? ))) Попробуйте применить ваш метод, только потом напишите получилось ли и и если да, то насколько кроссбраузерное решение получилось?
В качестве академического теста мне кажется, что сойдёт, но как для использования в бизнеслогике приложения лично мне идея не нравится. Данные клиента всё равно надо проверять на сервере и смысл отпускать его в offline? Вам тогда придётся синхронизировать код по проверке на клиенте и на сервере (или делать один код по проверке и запускать его, например в nashorn или node) Или задача сильно специфическая, что без функции offline не жить?
Но ведь это не проблема комментария. Те же summary вас не смущают?
Если вы посмотрите на разные системы комментирования, то они туда много чего запихивают. Приглядитесь внимательнее.
Я хочу быть правильно понятым и не настаиваю на своём стиле комментирования, но надеюсь, что вы согласитесь, что написать хороший комментарий бывает ничуть не проще написания хорошего кода, а так же сделать хорошую картинку и скриншот тоже бывает очень не просто. Но я считаю, что на сегодняшний день отсутствие комментов в виде картинок не позволяет выйти комментированию на качественно новый уровень.
Вот! И это одна из главных проблем создания таких комментариев. Однако, это не значит, что этот недостаток нельзя преодолеть. Разве нет? Вот есть плагин "Image Comments", есть плагин "MarkDown Editor". Если их функции объединить (а эти плагины open source), то время на прописывание url-ов уже становится незначительным и его можно не брать в расчёт. (вставка картинки по Ctrl-V в любом месте кода)
У меня на поддержке около десятка программ, и всякие плагины. Очень помогает.
Конечно, опыт реальный. За основу брал плагин: https://marketplace.visualstudio.com/items?itemName=MsBishop.ImageComments
Пришлось его немного допилить, чтобы можно было copy-paste картинок делать, но даже в том виде, в каком он есть уже комфортнее работать. Есть у меня прога обхода принтеров и снятия с них показаний. Типов 30. На каждый принтер надо было указать из какого места что снимать. Вот такие картинки уже удобнее освежать в памяти:
Если что, вот ещё интересный плагин для readme.md под Visual Studio: https://github.com/madskristensen/MarkdownEditor
И как-то на пару они хорошо дополняют друг друга. Один в коде картинки показывает, в другом readme удобно писать. Почти лепота. )
Первый раз столкнулся с человеком, который, кажется, любит Прометей сильнее, чем люблю его я! ))) С удовольствием почитал то, что вы написали.
Красивая аналогия, но ошибочная.
В качестве академического теста мне кажется, что сойдёт, но как для использования в бизнеслогике приложения лично мне идея не нравится. Данные клиента всё равно надо проверять на сервере и смысл отпускать его в offline? Вам тогда придётся синхронизировать код по проверке на клиенте и на сервере (или делать один код по проверке и запускать его, например в nashorn или node) Или задача сильно специфическая, что без функции offline не жить?