Комментирование блоков кода в Vim: быстрый гайд для Python

Быстрый ответ

Чтобы в Vim закомментировать блок кода на Python, выполните следующую последовательность действий:

1. Ctrl + V: вход в блочный визуальный режим.
2. Выделите необходимые строки с помощью стрелок.
3. Shift + I, затем вводим #.
4. Чтобы применить комментирование, нажмите Esc.

" Ctrl + V (вход в блочный визуальный режим)
" Shift + I (ввод символа), #
" Esc (комментирование всех выделенных строк)

Настройка эффективных комбинаций клавиш

Оптимизируем процедуру комментирования блоков кода, добавив настраиваемые сочетания клавиш в файле .vimrc.

1. Откройте ваш .vimrc командой: :e $MYVIMRC.
2. Вставьте следующие строки:

" Комментирование кода (Ctrl + c для быстрого выполнения)
vnoremap <C-c> :s/^/#/<CR>
" Удаление комментария (Ctrl + u вернет всё в исходное состояние)
vnoremap <C-u> :s/^#//<CR>

3. Перезапустите .vimrc или же Vim.

Таким образом, комментировать и раскомментировать блоки кода «на лету» становится возможным с помощью Ctrl + c и Ctrl + u.

Особые случаи

Переключатель — универсальное решение

Вы можете использовать функцию toggle для переключения между комментированием и раскомментированием блоков:

• Добавьте возможность переключения:

" Переключение комментариев (Ctrl + t выполнит данное действие)
vnoremap <C-t> :s/^/#/<CR>:noh<CR>gv:s/^#//<CR>:noh<CR>

• Выделите блок кода и нажмите Ctrl + t, чтобы активировать функцию переключения.

Использование номеров строк

Вы можете легко выделить блока кода используя номера строк:

1. Включите отображение номеров строк: :set number.
2. Используйте номера строк в командах:

:15,25s/^/#/

Это удобно, когда требуется закомментировать большие фрагменты кода.

Визуализация

Представьте, что ваш код – это семейство пингвинов, которых вы хотите накрыть пледом:

<Визуальный режим> 
Выберите «пингвинов»: `V` (или `Ctrl-V` для блока)
«Накройте» их пледом: `I#`

Теперь все ваш код скрыт под комментарием, словно пингвины под пледом.

Поддержание чистоты кода с помощью комментариев

Временное отключение больших фрагментов кода

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

Осмысленное использование комментариев

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

Пересмотр ваших комментариев

Комментирование через замену

Вы можете добавить # прямо в текст, используя команду замены, без входа в визуальный режим:

:10,20s/^/#/

При таком подходе символ # используется по своему назначению — он привносит комментарии, а не создаёт помехи.

Повышение продуктивности с помощью движений

Сочетайте команды комментирования и движения для повышения эффективности:

1. Комбинация # и движение вниз комментирует следующую строку.
2. Ctrl-v можно комбинировать с командами движения, такими как %, для навигации по блокам кода.

Использование плагинов

Для автоматизации рутинных операций рассмотрите использование плагинов, например vim-commentary от tpope:

Plug 'tpope/vim-commentary'

Это значительно упрощает комментирование кода, придавая вам хитрость лисы и мудрость питона.

Полезные материалы

1. Комментирование и раскомментирование строк | Vim Tips Wiki | Fandom — методы комментирования кода в Vim.
2. Работа с Python | Vim Tips Wiki | Fandom — настройка Vim под Python.
3. Practical Vim, Second Edition: Edit Text at the Speed of Thought by Drew Neil — книга о повышении скорости редактирования в Vim.
4. Тренировка пальцев / Learn Vimscript the Hard Way — курс по развитию навыков использования Vim.
5. GitHub – tpope/vim-commentary: commentary.vim: comment stuff out — плагин для удобного комментирования кода в Vim.
6. Vim documentation: usr_41 — документация Vim по настройке Python в качестве среды разработки.