Есть ли редактор, который показывает комментарии WYSIWYG?

Кто-нибудь видел редактор/IDE, который показывает комментарии WYSIWYG внутри кода? Я видел некоторые, которые показывают документы элемента в отдельной вкладке/окнах, но не вместе с кодом. Например, комментарий JavaDoc был бы намного понятнее и его было бы легче редактировать, если бы он не имел тегов и его можно было бы редактировать как фрагмент обычного текстового документа.

/**
 * Writes <code>Hello world!</code> to the <b>standard output</b>.
 * @seealso showGoodbye
 */
public static void showHello() {

Может быть что-то вроде этого:

/*
Записывает Hello world! в стандартный вывод.
См. также: showGoodbye()
*/

public static void showHello() {

но, редактируемый, конечно.

И для всех, у кого есть знания/опыт работы с открытыми IDE, такими как Eclipse, Netbeans и т. д.: будет ли слишком сложно реализовать это?


person Bráulio Bezerra    schedule 21.04.2009    source источник


Ответы (4)


Никогда такого не видел.

Однако большинство из них имеют режим «Hover», который покажет вам версию WYSIWYG, когда вы наведете курсор на класс/метод/переменную, на которую ссылается javadoc.

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

person Bill K    schedule 21.04.2009
comment
Да, я согласен, что для веб-разработки редактор WYSIWYG может быть плохой вещью. Но для простых комментариев без ‹div›, CSS и других относительно сложных вещей я думаю, что это может быть разумно. Какой-нибудь ctrl-b здесь, ctrl-i там никого не убьет. - person Bráulio Bezerra; 21.04.2009

Есть несколько второстепенных языков/IDE, которые отделяют представление программирования от хранилища, но в основном это исследовательские языки, и они в основном имеют дело с кодом, а не с комментариями. Поищите информацию об расширяемом программировании. Общая идея состоит в том, чтобы смоделировать код как AST в фоновом режиме и предоставить текстовый интерфейс для редактирования/отображения этой модели. Затем этот AST можно сохранить как обычный текст, s-выражения, XML или даже двоичное представление.

Было бы совсем несложно перейти от такой модели к модели, которая на самом деле украшала комментарии и давала вам интерфейс WYSIWYG.

person Eclipse    schedule 21.04.2009

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

person Svante    schedule 21.04.2009

Это не отвечает именно на то, что вы, кажется, спрашиваете. Но что касается эффективного создания комментариев, вы можете проверить Textmate. Посмотрите этот демонстрационный видеоролик по использованию и созданию комментариев. В частности, режимы комментирования «баннер», «голова» и «задача». Кроме того, если вам нужно форматирование комментариев в определенной структуре формата, вы, вероятно, можете создать настраиваемый пакет, который облегчает форматирование комментариев по мере их ввода. Я бы предположил, что вы можете создать последовательность входа и выхода для входа и выхода из режима комментариев, а также заставить редактор переносить текстовый блок после завершения комментария. То, что делает Textmate популярным среди многих людей, — это расширяемость его системы пакетов.

person Gordon Potter    schedule 14.09.2009