LINUX.ORG.RU

Редактор кода/IDE с возможностью цеплять картинки в качестве комментариев?

 , ,


0

1

Сабж. Для каких то сложных кусков приходится либо рисовать схемки на доске/бумажке и долго думать (а потом схемка теряется и через месяц ты понять не можешь что к чему), либо явно пихать в код схемки в ASCII-графике типа

bool FullEdge::try_rotate(FrontTracer *ftracer, BlockQueue<Edge> &queue){
...
/*
.      / a1 b1 \                 / a1 \
. 0   / / | | \ \   3       0  a2 /  \ eA  3
.   a2 /  |t|  \ b2            / / tA \ \
.   / /   |h|   \ \          eA /~~~~~~\ a2
. eA ( tA |i| tB ) eB  ===>       this 
.   \ \   |s|   / /          b1 \~~~~~~/ eB
.    a1\  | |  / b1            \ \ tB / /
. 1   \ \ | | / /   2       1  eB \  / b1  2
.      \ a2 b2 /                 \ b2 /
*/
...

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

Идея не моя а коллеги, но кажется очень здравой. Есть ли что нить подобное (в идеале в виде плагина к виму/имаксу)?

★★★★

Последнее исправление: AntonI (всего исправлений: 2)

mode для емакса такой написать просто, но не вижу применения - будет лишь загрязняться исходник.

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

SL_RU ★★★★
()

ты ещё HTML5 с разметкой, видяшками и анимированными смайликами в качестве исходников программ захоти

Harald ★★★★★
()

Кодь в MS Word, там так можно.

Bfgeshka ★★★★★
()
Ответ на: комментарий от entefeed

В 2050 сорцы будут не в плейнтексте, а в виде наглядых приложух на 1Се.

obv fix

mos ★★☆☆☆
()

Для таких вещей в сложных проектах используется отдельный архитектурный софт. Пихать структуру проекта в код — странное желание.

morse ★★★★★
()

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

Crocodoom ★★★★★
()

Идея не моя а коллеги

Да-да, мы тебе верим.

но кажется очень здравой

Ну пишите код в Markdown, чо. Или в HTML5, там не только картинки вставлять можно. Компиляться уже не будет, но разве это проблема?

mord0d ★★★★★
()
Ответ на: комментарий от ugoday

ОП хочет растровые цветные имги вставлять.

SL_RU ★★★★
()

В IDE от JetBrains есть удобная подсказка по файлам ресурсов изображений:

https://exlmoto.ru/wp-content/Images/comments/gish2.png

Но чтобы прямо такое, как ты хочешь, такого я ещё нигде не видел.

EXL ★★★★★
()

Doxygen же!

Произвольные картинки цепляются, как сказали, одной строчкой. Еще можно диаграмки рисовать в формате graphviz.

Альтернативно можно конвертировать картинки в ASCII крафику - см. тулы на основе aalib, libcaca.

Kroz ★★★★★
()

Чего-то много завелось любителей странного. Как бы их не стало больше, чем любителей нормального, тогда конец мировой цивилизации.

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

Partisan ★★★★
()

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

В том смысле, чтобы *графическая* картинка висела в коде?

Zubok ★★★★★
()

man UML и средства для работы с ним.

peregrine ★★★★★
()

В Javadoc можно вставлять теги img

/**
 * <img src="/tmp/img.png"/>
 */
public class Test123 {
    public static void main(String[] args) throws Exception {

    }
}

Если в Идее показать коммент по Ctrl+Q, то картинка подхватится.

Пути, конечно, лучше относительные, но только что проверил с абсолютным, работает.

anonymous
()
Ответ на: комментарий от peregrine

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

morse ★★★★★
()
Ответ на: комментарий от morse

А комментарий к классу? К модулю?

anonymous
()

в emacs есть плагин для рисования ASCII

bvn13 ★★★★★
()
Ответ на: комментарий от mord0d

Это уже будут не просто к картиночкам. Тут вообще все переварачивается. Была документация к коду, а будет код к документации. Возможно, это даже улучшит качество документаций к ПО.

SR_team ★★★★★
()

В IDEA показывает картинки для документации методов RxJava, как оно там под капотом реализовано, честно, не вникал.
https://ibb.co/bTc17f

Jefail ★★★★
()
Ответ на: комментарий от SR_team

Возможно, это даже улучшит качество документаций к ПО.

Код был говном, станет ещё хуже.

Сейчас можно глянуть в код и понять, что оно делает (хотя бы в теории). Потом в коде будет магия, а в документации — вода.

mord0d ★★★★★
()
Ответ на: комментарий от e1nste1n

Я в курсе:-) Но там картинки вроде как низя.

AntonI ★★★★
() автор топика
Ответ на: комментарий от morse

Вообще говоря комменты должны говорить ещё КАК она это делает.

AntonI ★★★★
() автор топика
Ответ на: комментарий от peregrine

UML вообще про другое. Речь не идёт о структуре классов и пр. - речь идёт именно об иллюстрации конкретных решений в конкретной строке кода. Я хз чё там в продакшене, у нас в число дробилках этого очень не хватает.

AntonI ★★★★
() автор топика
Ответ на: комментарий от Partisan

Спасибо кэп, мы таки сидим под гитом. И если последовать Вашему совету, то картинок будет на порядок больше чем файлов с кодом - запаришься искать.

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

AntonI ★★★★
() автор топика
Ответ на: комментарий от SL_RU

Насчёт ненужно очень спорно, но с дохидженом вообще мысль мне нравится - это наверное самое простое решение. Спасибо.

AntonI ★★★★
() автор топика
Ответ на: комментарий от Crocodoom

Не, это изврат от бедности. Такой графики не хватает, нам ещё формулы втыкать обычно надо...

AntonI ★★★★
() автор топика

Внезапно можно код вставлять прямо в документацию на LaTeX. В результате у тебя есть файлик, из которого можно скомпилировать как сырцы, так и красивую PDF.

hateyoufeel ★★★★★
()

Был какой-то уеб-сервис, позволяющий мышкой рисовать диаграммы и рендерить в ascii-графику

annulen ★★★★★
()

PlantUML плагин, например. У эклипса на яве так можно.

Shadow ★★★★★
()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.