Code Remark — плагин для IDE от Jetbrains

Code Remark – это плагин для среды разработки Jetbrains IDE, который отличается от обычных комментариев к коду и может быть применён к файлам с исходным кодом, доступным только для чтения.

中文 | Сообщить о проблемах

Пример

Как установить

1. Найдите Code Remark в магазине плагинов для IDE: https://plugins.jetbrains.com/plugin/17805-code-remark.

2. Или загрузите установочный пакет через релизы и установите его вручную.

Инструкции по использованию

Исходный код — это файл, доступный только для чтения, как добавить замечания?

1. Откройте файл исходного кода с помощью IDEA.

2. В любом месте вы можете выбрать один из следующих трёх способов, чтобы вызвать всплывающий слой Popup и добавить контент:

   • Alt + ENTER -> [MARK] Добавить/Изменить замечание [РЕКОМЕНДУЕТСЯ];
   • Меню всплывающего окна редактора / Инструменты -> Добавить замечание.

3. Используйте контекстное меню правой кнопкой мыши «Навигация по замечаниям» в редакторе, чтобы просмотреть все замечания, добавленные в текущий файл.

4. В представлении Вид → Окна инструментов → Закладки → Замечания просмотрите все замечания текущего проекта.

Горячие клавиши

• Добавить / Изменить: <Alt> + <ENTER> -> [MARK] Add/Edit remark [RECOMMEND].
• Сохранить: <shift> + <ENTER>.
• Удалить: <shift> + <DETELE>.
• Отменить: <ESC>.

Вы можете выполнить поиск по remark через Preferences-Keymap и настроить соответствующие сочетания клавиш для указанной операции.

Синхронизация с репозиторием Git

Соответствующий файл находится по адресу ${yourProject}/.idea/code-remark.xml. Добавьте его в систему контроля версий Git, чтобы синхронизировать комментарии к коду.