Я вот чего не пойму — что так в 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>Ты уже сделал глобальный опрос населения?