Я вот чего не пойму — что так в IDE печально с комментариями???
Доступны только текстовые комментарии, которые появились со времен первых перфокарт, когда на перфокарте писали карандашиком что она делает.
Где комментарии в виде формул в стиле редактора формул ворда?
Почему я не могу сделать комментарий в виде картинки?
Почему не могу сделать коммент в виде таблички или блок схемы или чарта какого-нибудь?
Или могу?
Мой опыт ограничивается Visual Studio 2008, Qt Creator.
Пусть бы под плюсиками лежали любые комментарии или еще бы какое концептуальное решение
Здравствуйте, lazyrun, Вы писали:
L>Я вот чего не пойму — что так в IDE печально с комментариями??? L>Доступны только текстовые комментарии, которые появились со времен первых перфокарт, когда на перфокарте писали карандашиком что она делает. L>Где комментарии в виде формул в стиле редактора формул ворда? L>Почему я не могу сделать комментарий в виде картинки? L>Почему не могу сделать коммент в виде таблички или блок схемы или чарта какого-нибудь? L>Или могу? L>Мой опыт ограничивается Visual Studio 2008, Qt Creator.
L>Пусть бы под плюсиками лежали любые комментарии или еще бы какое концептуальное решение
Как мне кажется, проблемы с более сложными комментариями две:
1. Они должны быть совместимы с имеющимися средствами разработки.
2. Они должны быть текстовыми для корректного хранения в системах контроля версий.
В связи с этим напрашивается решения, которое мы в команде когда-то обдумывали.
Плагин для, к примеру, Visual Studio, который бы позволял удобно и легко вставлять в код фото/аудио/видео комментарии.
С точки зрения реализации в код вставляется обычный комментарий вида:
// c:/build/picture1.png
или
// ../../speach.mp3
но в IDE это автоматически показывыается как картинка или проигрывается как музыка. При этом файлы хранятся в специально-выделенном месте, а не в коде.
Было бы это удобно? Трудно сказать без массштабных экспериментов. Но часто фотографию схем с доски обсуждений можно было бы приложить к проекту. Красиво эти схемы все-равно никто не оформляет, а так была бы надежда, что какая-то документация останется. Голосовые комментарии тоже могли бы быть полезными. Возможно это позволит лучше комментировать код, так как писать подробные комментарии люди ленятся, а наговорить может быть бы не ленились.
Здравствуйте, lazyrun, Вы писали:
L>Я вот чего не пойму — что так в IDE печально с комментариями??? L>Доступны только текстовые комментарии, которые появились со времен первых перфокарт, когда на перфокарте писали карандашиком что она делает.
Это потому, что до сих пор хранение исходников (и комментариев, соответственно) в виде простого текста — стандарт "де факто" в разработке.
Здравствуйте, lazyrun, Вы писали:
L>Я вот чего не пойму — что так в IDE печально с комментариями??? L>Доступны только текстовые комментарии, которые появились со времен первых перфокарт, когда на перфокарте писали карандашиком что она делает. L>Где комментарии в виде формул в стиле редактора формул ворда? L>Почему я не могу сделать комментарий в виде картинки? L>Почему не могу сделать коммент в виде таблички или блок схемы или чарта какого-нибудь? L>Или могу? L>Мой опыт ограничивается Visual Studio 2008, Qt Creator.
L>Пусть бы под плюсиками лежали любые комментарии или еще бы какое концептуальное решение
А смысл в картинке на полстраницы? Хочется увидеть концепцию — читай документацию, там в нормальных проектах всё расписано и примеры кода под диаграммами приведены или описание API.
Здравствуйте, Евгений Рыжков, Вы писали:
ЕР>Было бы это удобно? Трудно сказать без массштабных экспериментов. Но часто фотографию схем с доски обсуждений можно было бы приложить к проекту. Красиво эти схемы все-равно никто не оформляет, а так была бы надежда, что какая-то документация останется. Голосовые комментарии тоже могли бы быть полезными. Возможно это позволит лучше комментировать код, так как писать подробные комментарии люди ленятся, а наговорить может быть бы не ленились.
О это было бы круто! У вас есть какой-то такой редактор?
Представляю голосовые комментарии: сидит толпа программистов и каждый под нос бормочет комментарии )) И все пишется! Весь мат и ругань на того кто писал до тебя этот код ))
Схемы вот прикладывать это было бы клево!
Я чувствую будущее за такими редакторами!
Здравствуйте, SE, Вы писали:
SE>Здравствуйте, lazyrun, Вы писали:
L>>Я вот чего не пойму — что так в IDE печально с комментариями??? L>>Доступны только текстовые комментарии, которые появились со времен первых перфокарт, когда на перфокарте писали карандашиком что она делает.
SE>Это потому, что до сих пор хранение исходников (и комментариев, соответственно) в виде простого текста — стандарт "де факто" в разработке.
И что? Пусть код будет текстовым, но ИДЕ то пусть даст возможность оформить код как я хочу.
Взять тот же доксиген с его комментами типа /*! */
Вот это клевое решение.
Так почему бы его чуть слегка не расширить например так
/*!
\image c:\image.png
\brief ролик
*/
B>А смысл в картинке на полстраницы? Хочется увидеть концепцию — читай документацию, там в нормальных проектах всё расписано и примеры кода под диаграммами приведены или описание API.
Зачем на полстранице — пусть будет ссылочка — "к этому коду есть картинка" хочешь посмотреть — жмакнул и посмотрел
Здравствуйте, lazyrun, Вы писали:
L>Здравствуйте, SE, Вы писали:
SE>>Здравствуйте, lazyrun, Вы писали:
L>>>Я вот чего не пойму — что так в IDE печально с комментариями??? L>>>Доступны только текстовые комментарии, которые появились со времен первых перфокарт, когда на перфокарте писали карандашиком что она делает.
SE>>Это потому, что до сих пор хранение исходников (и комментариев, соответственно) в виде простого текста — стандарт "де факто" в разработке.
L>И что? Пусть код будет текстовым, но ИДЕ то пусть даст возможность оформить код как я хочу. L>Взять тот же доксиген с его комментами типа /*! */ L>Вот это клевое решение. L>Так почему бы его чуть слегка не расширить например так L>/*! L>\image c:\image.png L>\brief ролик L>*/
L>А ИДЕ пусть все цепляет и оформляет
Есть желание — можешь приступать к реализации. Видимо, никому больше такое нафиг не нужно.
Здравствуйте, lazyrun, Вы писали:
L>Здравствуйте, Евгений Рыжков, Вы писали:
ЕР>>Было бы это удобно? Трудно сказать без массштабных экспериментов. Но часто фотографию схем с доски обсуждений можно было бы приложить к проекту. Красиво эти схемы все-равно никто не оформляет, а так была бы надежда, что какая-то документация останется. Голосовые комментарии тоже могли бы быть полезными. Возможно это позволит лучше комментировать код, так как писать подробные комментарии люди ленятся, а наговорить может быть бы не ленились.
L>О это было бы круто! У вас есть какой-то такой редактор?
Нет, но мы обсуждали концепт. Пришли к выводу что должна быть очень качественная мощная интеграция в IDE, чтобы грубо-говоря нажал в visual studio shift-ins и картинка вставилась. А не так — файл вручную сохрани, путь вручную получи, вставь его в IDE в специальном формате...
ЕР>Нет, но мы обсуждали концепт. Пришли к выводу что должна быть очень качественная мощная интеграция в IDE, чтобы грубо-говоря нажал в visual studio shift-ins и картинка вставилась. А не так — файл вручную сохрани, путь вручную получи, вставь его в IDE в специальном формате...
Это понятно. Думаю такая задача по зубам только Microsoft.
Здравствуйте, blackhearted, Вы писали:
B>Здравствуйте, lazyrun, Вы писали:
L>>Здравствуйте, SE, Вы писали:
SE>>>Здравствуйте, lazyrun, Вы писали:
L>>>>Я вот чего не пойму — что так в IDE печально с комментариями??? L>>>>Доступны только текстовые комментарии, которые появились со времен первых перфокарт, когда на перфокарте писали карандашиком что она делает.
SE>>>Это потому, что до сих пор хранение исходников (и комментариев, соответственно) в виде простого текста — стандарт "де факто" в разработке.
L>>И что? Пусть код будет текстовым, но ИДЕ то пусть даст возможность оформить код как я хочу. L>>Взять тот же доксиген с его комментами типа /*! */ L>>Вот это клевое решение. L>>Так почему бы его чуть слегка не расширить например так L>>/*! L>>\image c:\image.png L>>\brief ролик L>>*/
L>>А ИДЕ пусть все цепляет и оформляет
B>Есть желание — можешь приступать к реализации. Видимо, никому больше такое нафиг не нужно.
Нужно, нужно!
Топикстартер!
Дерзай!
Может выйдешь в миллионеры.
Не шутка.
Здравствуйте, lazyrun, Вы писали:
L>Зачем на полстранице — пусть будет ссылочка — "к этому коду есть картинка" хочешь посмотреть — жмакнул и посмотрел
Что мешает в коммент вставить ссылку на вики проекта? "жмакнул и посмотрел"
Здравствуйте, Aikin, Вы писали:
A>Здравствуйте, lazyrun, Вы писали:
L>>Зачем на полстранице — пусть будет ссылочка — "к этому коду есть картинка" хочешь посмотреть — жмакнул и посмотрел A>Что мешает в коммент вставить ссылку на вики проекта? "жмакнул и посмотрел"
Здравствуйте, lazyrun, Вы писали:
L>Я вот чего не пойму — что так в IDE печально с комментариями??? L>Доступны только текстовые комментарии, которые появились со времен первых перфокарт, когда на перфокарте писали карандашиком что она делает. L>Где комментарии в виде формул в стиле редактора формул ворда? L>Почему я не могу сделать комментарий в виде картинки? L>Почему не могу сделать коммент в виде таблички или блок схемы или чарта какого-нибудь? L>Или могу? L>Мой опыт ограничивается Visual Studio 2008, Qt Creator.
L>Пусть бы под плюсиками лежали любые комментарии или еще бы какое концептуальное решение
Javadoc умеет rich text, картинки вроде видел, таблицы умеет. Eclipse и Idea хорошо поддерживают (редактирование, конечно, не WYSIWYG, а HTML-like, но по-моему всем программистам это и так удобнее).
Здравствуйте, lazyrun, Вы писали:
L>Здравствуйте, blackhearted, Вы писали:
L>>>А ИДЕ пусть все цепляет и оформляет
B>>Есть желание — можешь приступать к реализации. Видимо, никому больше такое нафиг не нужно.
L>Ты уже сделал глобальный опрос населения?
Нет, я не делал. Но странно, почему "столь важной" фичи до сих пор нет, если она нужна сколь-нибудь значимой части населения.
Здравствуйте, lazyrun, Вы писали:
L>Здравствуйте, Aikin, Вы писали:
A>>Здравствуйте, lazyrun, Вы писали:
L>>>Зачем на полстранице — пусть будет ссылочка — "к этому коду есть картинка" хочешь посмотреть — жмакнул и посмотрел A>>Что мешает в коммент вставить ссылку на вики проекта? "жмакнул и посмотрел"
L>Отсутствие википроекта?
Здравствуйте, lazyrun, Вы писали:
L>Здравствуйте, blackhearted, Вы писали:
L>>>А ИДЕ пусть все цепляет и оформляет
B>>Есть желание — можешь приступать к реализации. Видимо, никому больше такое нафиг не нужно.
L>Ты уже сделал глобальный опрос населения?
Здравствуйте, lazyrun, Вы писали:
L>Я вот чего не пойму — что так в IDE печально с комментариями??? L>Доступны только текстовые комментарии, которые появились со времен первых перфокарт, когда на перфокарте писали карандашиком что она делает. L>Где комментарии в виде формул в стиле редактора формул ворда? L>Почему я не могу сделать комментарий в виде картинки? L>Почему не могу сделать коммент в виде таблички или блок схемы или чарта какого-нибудь? L>Или могу? L>Мой опыт ограничивается Visual Studio 2008, Qt Creator.
L>Пусть бы под плюсиками лежали любые комментарии или еще бы какое концептуальное решение
На что только не пойдут программисты что бы не писать код...
Этож сколько времени уйдёт на написания комментария?
Да и пощадите программмистов,
пока комменты пишутся в текстовом виде они могут поддерживать свои навыки вербального общения.
А так, через пяток лет получим программистов которые хлеб в магазине купить не могут без преобразователя формул в слова...
А если серьёзно — если программист не может словами описать что делается в том или ином месте его кода, то код надо переписывать, поэтому текстовые комментарии также служат неким показателем качества кода — когда пишешь коммент ещё раз продумываешь как ведёт себя программа и есть шанс сразу исправить какой нибудь по досадному недоразумению затесавшийся в неё баг.
И кстати формулы в комментах имхо кромешный идиотизм!
А насчёт картинок, диаграмм и табличек...хех, мы получим кучу косяков пытаясь перенести проект созданный в одной IDE в другую. Этих косяков и сейчас иногда хватает, зачем лишняя головная боль если всё вышеперечисленной легко можно напечатать/нарисовать/начертить/сфоткать/etc и засунуть куда нибудь в проект?
А можно поподробней, почему формулы — идиотизм? Я понимаю: самодокументируемый код и все такое, но по-хорошему шаг в стророну от бизнес-логики и крындец.
Как текстом выразить способ решения уравнения Навье-Стокса? Как объяснить алгоритмы расчета коллизии без рисунка?
Как, а главное, зачем, переименовывать переменные, если в оригинальном алгоритме они были мнемонично названы "a", "b" и "n" ?
Я понимаю, что есть и википедия, и внутренний сайт, но сами же знаете как быстро они выходят из сизнронизации.
А небольшой rich (rich как в слове RTF) комментарий над кодом был бы очень к месту.
Здравствуйте, silent_bob, Вы писали:
_>Я понимаю, что есть и википедия, и внутренний сайт, но сами же знаете как быстро они выходят из сизнронизации. _>А небольшой rich (rich как в слове RTF) комментарий над кодом был бы очень к месту.
Здравствуйте, lazyrun, Вы писали:
L>Я вот чего не пойму — что так в IDE печально с комментариями??? L>Доступны только текстовые комментарии, которые появились со времен первых перфокарт, когда на перфокарте писали карандашиком что она делает. L>Где комментарии в виде формул в стиле редактора формул ворда? L>Почему я не могу сделать комментарий в виде картинки? L>Почему не могу сделать коммент в виде таблички или блок схемы или чарта какого-нибудь? L>Или могу?
В JavaDoc'е можешь. И такие комментарии нормально обрабатываются VCS, потому что текстовые (банально html), кроме картинок, конечно. И это уже лет фиг знает сколько. Подозреваю, что в .NET что-то подобное должно быть.
В общем, описанная проблема касается только конкретных убогих сред разработок.
Здравствуйте, lazyrun, Вы писали:
L>Я вот чего не пойму — что так в IDE печально с комментариями??? L>Доступны только текстовые комментарии, которые появились со времен первых перфокарт, когда на перфокарте писали карандашиком что она делает.
Так ведь стало хуже, на перфокартах можно было и картинки и формулы иметь
L>Где комментарии в виде формул в стиле редактора формул ворда? L>Почему я не могу сделать комментарий в виде картинки? L>Почему не могу сделать коммент в виде таблички или блок схемы или чарта какого-нибудь?
Если идея в том, чтобы в коде было @img: ../images/alg.png а IDE показывала картинку, а вместо @eq: int(0, +inf, x^2) интеграл, то это идея может быть и здравая. Это кстати легко внедрить в любую существующую IDE без радикальных изменений — надо показывать их при наведении мышки на @команду.
А расширять редактор кода ричтекстом — идея ущербная. Сначала не хватает таблички, потом обтекания текстом, потом формул, потом стилей и т.д. пока не получится дичайшая помесь всех программ в MS Office. Подумайте только над количеством новых кнопок на тулбарах, которыми это придется вызывать и контроллить — никто этим пользоваться не будет. Даже молчу о том, как контроль версий будет делать diff всего этого.
Здравствуйте, Кодёнок, Вы писали:
Кё>А расширять редактор кода ричтекстом — идея ущербная. Сначала не хватает таблички, потом обтекания текстом, потом формул, потом стилей и т.д. пока не получится дичайшая помесь всех программ в MS Office. Подумайте только над количеством новых кнопок на тулбарах, которыми это придется вызывать и контроллить — никто этим пользоваться не будет. Даже молчу о том, как контроль версий будет делать diff всего этого.
Я так понимаю, единственный психологический барьер — скрытие части текста комментариев (тегов разметки) средствами IDE.
Допустим, если ввести в текст комментариев что-то вроде BBCode или простейшей html-разметки... С возможностью отключать форматированный вывод как для всех комментариев, так и для конкретного (по аналогии с outlining — можно визуально скрыть кусок кода, но из файла-то он никуда не делся... также и здесь: скрываем теги разметки, в файле они остаются, вместо них отображаем жирный, подчеркнутый текст, картинки и т.д.... )
Гиперссылки кстати отображаются во всез IDE. Правда, там нет сокрытия части текста.
On 30/07/10 00:23, x-code wrote: > Допустим, если ввести в текст комментариев что-то вроде BBCode или > простейшей html-разметки...
Вроде javadoc существует уж десяток лет, а то и больше.
Отображать форматированную с картинками, гиперссылками подсказку по классу/методу/параметру, коллапсить коментарии — ИДЕЯ умеет уже несколько лет.
Или я что-то не понял? В чём новизна?
Posted via RSDN NNTP Server 2.1 beta
но это не зря, хотя, может быть, невзначай
гÅрмония мира не знает границ — сейчас мы будем пить чай
Здравствуйте, lazyrun, Вы писали:
L>Я вот чего не пойму — что так в IDE печально с комментариями??? L>Доступны только текстовые комментарии, которые появились со времен первых перфокарт, когда на перфокарте писали карандашиком что она делает. L>Где комментарии в виде формул в стиле редактора формул ворда? L>Почему я не могу сделать комментарий в виде картинки? L>Почему не могу сделать коммент в виде таблички или блок схемы или чарта какого-нибудь? L>Или могу? L>Мой опыт ограничивается Visual Studio 2008, Qt Creator.
L>Пусть бы под плюсиками лежали любые комментарии или еще бы какое концептуальное решение
Оказывается под 2010-ю студию уже полгода как есть плагин: Image Insertion
Здравствуйте, blackhearted, Вы писали:
B>Здравствуйте, lazyrun, Вы писали:
L>>Я вот чего не пойму — что так в IDE печально с комментариями??? L>>Доступны только текстовые комментарии, которые появились со времен первых перфокарт, когда на перфокарте писали карандашиком что она делает. L>>Где комментарии в виде формул в стиле редактора формул ворда? L>>Почему я не могу сделать комментарий в виде картинки? L>>Почему не могу сделать коммент в виде таблички или блок схемы или чарта какого-нибудь? L>>Или могу? L>>Мой опыт ограничивается Visual Studio 2008, Qt Creator.
L>>Пусть бы под плюсиками лежали любые комментарии или еще бы какое концептуальное решение
B>А смысл в картинке на полстраницы? Хочется увидеть концепцию — читай документацию, там в нормальных проектах всё расписано и примеры кода под диаграммами приведены или описание API.
Смысл в том, что если код хреново написан, непонятный, недостаточно разграничен, то хочется или формулы написать, или табличку, или диаграммку, или еще как-нибудь откосить от необходимости поправить код.
Здравствуйте, silent_bob, Вы писали:
_>А можно поподробней, почему формулы — идиотизм? Я понимаю: самодокументируемый код и все такое, но по-хорошему шаг в стророну от бизнес-логики и крындец.
Потому что комментарии должны пояснять что делает код в терминах предметной области, и в случае необходимости содержать ссылку на метод которым решается определённая задача. Примерно так:
/*
Сортируем книги в каталоге по названию/цене/etc
......
......
......
(сортировка выполняется методом пузырька — ссылка на внутреннюю вики или ещё куда где объясняется сам алгоритм и почему именно он был выбран)
*/
_>Как текстом выразить способ решения уравнения Навье-Стокса? Как объяснить алгоритмы расчета коллизии без рисунка? _>Как, а главное, зачем, переименовывать переменные, если в оригинальном алгоритме они были мнемонично названы "a", "b" и "n" ?
Давайте определимся, или мы говорим о специализированных областях где весь код чуть менее чем полностью состоит из матана или мы говорим в общем о техники написания комментариев для "обычного" кода? Специфика всё таки есть, несомненно. Но всё равно, в таком случае надо писать что код делает а не то как он что то делает(про то как он делает надо писать во внутренней документации, там же расписывать почему выбран тот или иной метод решения задачи, и ссылку на это можно оставлять в комментах).
Переименновывать переменные надо по той же причине, почему комментарии надо писать в терминах предметной области. Если у вас в предметной области есть такие термины как "a", "b" и "n" то конечно надо их и писать. ) Естественно что есть и исключения, тут главное помнить что читать код может тот кто его не писал, отсюда и плясать — как написать наиболее понятно и очевидно.
_>Я понимаю, что есть и википедия, и внутренний сайт, но сами же знаете как быстро они выходят из сизнронизации. _>А небольшой rich (rich как в слове RTF) комментарий над кодом был бы очень к месту.
Ну актуальностью вики и остальной документации должен заниматься отдельно взятый индивидум (или возможно даже целая команда, тут всё от величины проекта зависит).
Если так дело пойдет, то проще к Word'у прикрутить Компилятор в виде плагина, чем наоборот
А чё, это идея. Пишем плагин к ворду, который будет из doc-файлов "вытаскивать" текст программы и передовать его компилятору.
И можно смело весь solution в виде doc-файлов оформлять
Здравствуйте, Евгений Рыжков, Вы писали:
ЕР>Плагин для, к примеру, Visual Studio, который бы позволял удобно и легко вставлять в код фото/аудио/видео комментарии. ЕР>С точки зрения реализации в код вставляется обычный комментарий вида: ЕР>// c:/build/picture1.png ЕР>или ЕР>// ../../speach.mp3
Ну можно картинку или там звуковой комент к файлу xxxyyy.cpp класть в файл xxxyyy.jpg xxxyyy.avi и класть в тот же проект вижуал студии. И посмотреть удобно и не мешает и плагинов никаких не надо...
Все эмоциональные формулировки не соотвествуют действительному положению вещей и приведены мной исключительно "ради красного словца". За корректными формулировками и неискажённым изложением идей, следует обращаться к их автором или воспользоваться поиском
Здравствуйте, lazyrun, Вы писали:
L>Я вот чего не пойму — что так в IDE печально с комментариями???
Посмотрите на возможности по расширению редактора Visual Studio 2010. Он написан на WPF и легко расширяется — такие вещи, как превращения комментариев в картинки, проигрывания звука там сделать довольно легко. Даже читал в блоге (к сожалению пока никак не найду ссылку) что кто-то сделал такое расширение. И свою IDE писать не надо — просто плагин для Visual Studio.
