Help:Vscode

From Svacer Wiki
Jump to navigation Jump to search

Инструкция по работе с расширением Svacer для Visual Studio Code

Установка

Установка из официального магазина VSCode

На странице расширений VSCode найдите Svacer и нажмите кнопку Установить:

Установка расширения из магазина приложений

.

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

Установка из файла

Получить установочный файл можно в пользовательском интерфейсе сервера Svacer. Для этого выберите пункт Скачать расширение для VSCode в меню пользователя:


Имя установочного файла имеет вид: svacer-<version>.vsix.

Для установки:

1. На странице расширений VSCode нажмите кнопку и выберите пункт Установка из VSIX:
2. В открывшемся окне проводника выберите скачанный установочный файл svacer-<version>.vsix.

Также расширение Svacer можно установить с помощью параметра командной строки --install-extension, указав путь к файлу:
code --install-extension <path-to-file>/svacer-<version>.vsix
Приложение считается успешно установленным, если появилось соответствующее сообщение и на панели слева отобразилась вкладка расширения .

Настройка подключения к серверу Svacer

Для работы расширения требуется настроить подключение к серверу Svacer:

1. Перейдите на вкладку расширения .
2. На панели ИНСТРУМЕНТЫ SVACER: Информация Svacer нажмите кнопку и выберите пункт Параметры расширения.


В правой части окна VSCode откроется вкладка Параметры.


3. Укажите адрес и порт сервера Svacer.
4. Настройте остальные параметры (опционально).
Название Описание По умолчанию
Настройки сервера
Hostname Имя или IP-адрес Svacer localhost
Port Порт Svacer 8080

Если значение оставить пустым, то будет использован порт по умолчанию для выбранного протокола

Use Https Использовать протокол https false
Настройки рабочей области
Include Traces Отображать трассу для маркеров true
Include Comments Отображать комментарии пользователей true

Авторизация

Для доступа к серверу Svacer требуется авторизоваться:

1. Нажмите кнопку и выберите пункт Войдите с помощью SvaceAuth, чтобы использовать Svacer, либо на вкладке расширения в разделе ИНФОРМАЦИЯ SVACER нажмите кнопку Авторизоваться.
Авторизация. Вариант 1
Авторизация. Вариант 2
2. Нажмите кнопку Разрешить в появившемся окне:

3. Подтвердите открытие в браузере внешнего веб-сайта для авторизации.
В браузере по умолчанию откроется страница ввода учётных данных:

4. Введите логин и пароль.
Отобразится страница с запросом разрешения:

5. Нажмите кнопку Разрешить.
6. Подтвердите открытие расширения Svacer в VSCode.

Откроется окно VSCode с открытой вкладкой расширения, на которой отображается список проектов Svacer:

Алгоритм работы

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

  1. Открыть папку для хранения исходного кода.
  2. Выбрать проект, ветку и снимок.
  3. Загрузить исходный код.
  4. Загрузить маркерs.
  5. Выбрать маркер.
  6. Посмотреть исходный код файла.
  7. Разметить маркеры.
  8. Добавить, изменить или удалить комментарии (опционально).
  9. Заблокировать или разблокировать маркеры (опционально).
  10. Выбрать другие снимки проекта (опционально).

Открытие папки исходного файла

Чтобы открыть папку для хранения исходного кода:

1. Перейдите в окно проводника операционной системы одним из трех способов:
  • способ 1 – в меню Файл выберите пункт Открыть папку;
  • способ 2 – на вкладке Проводник нажмите кнопку Открыть папку;
  • способ 3 – нажмите клавиши CTRL+K и следом CTRL+O.
2. Выберите папку, в которой будет храниться исходный код снимка проекта.


Открытая папка и её содержимое будет отображается на вкладке Проводник.

Выбор проекта, ветки и снимка

Загрузка исходного кода

Выбор маркера

Просмотр исходного кода

Разметка маркера

Управление комментариями

Блокировка и разблокировка маркеров

Выбор другого снимка проекта

Поддерживаемые команды