VS Code for Python For non-programmers

01-ide.md

Установка VS Code для просмотра Python-файлов в Windows

1. Скачайте бесплатный Visual Studio Code с официального сайта: Скачать VS Code

2. Выберите Windows — User Installer x64, запустите файл и установите программу с настройками по умолчанию. Microsoft рекомендует User Installer большинству пользователей Windows.

3. Запустите VS Code и нажмите Ctrl+Shift+X.

4. Найдите и установите расширение Python от Microsoft: Python для Visual Studio Code

Оно добавит подсветку синтаксиса, навигацию и анализ Python-файлов.

Нужно ли устанавливать сам Python?

Нет, если требуется только открывать и читать файлы .py.

Интерпретатор Python понадобится только для запуска или отладки программ. VS Code запускает код через установленный и выбранный интерпретатор.

02-plantuml.md

Установка PlantUML для VS Code в Windows

1. Установите Java

   Скачайте бесплатную Eclipse Temurin Java 21 LTS:

   Скачать Java Temurin

   На странице выберите:

   • Version: 21 LTS
   • Operating System: Windows
   • Architecture: x64
   • Package: JRE или JDK
   • Installer: MSI

   Запустите скачанный .msi и оставьте стандартные параметры установки. PlantUML требует Java 11 или новее.

2. Установите расширение PlantUML

   Откройте официальную страницу расширения:

   PlantUML для VS Code — jebbs

   Нажмите Install. Либо откройте VS Code, нажмите Ctrl+Shift+X, найдите PlantUML от jebbs и установите его.

3. Отдельно устанавливать PlantUML и Graphviz не нужно

   Расширение для Windows уже содержит встроенные:

   • plantuml.jar;
   • Graphviz;
   • подсветку синтаксиса PlantUML;
   • шаблоны и автодополнение.

   Нужна только установленная Java.

4. Проверьте работу

   Создайте файл diagram.puml:

   @startuml
   Alice -> Bob: Привет
   Bob --> Alice: Ответ
   @enduml

   Откройте файл в VS Code и нажмите:

   Alt+D
   

   Откроется предварительный просмотр диаграммы.

5. Сохранение изображения

   Нажмите Ctrl+Shift+P, введите:

   PlantUML: Export Current Diagram
   

   Затем выберите формат, например PNG или SVG.

Официальная страница отдельного PlantUML-файла plantuml.jar:

Скачать PlantUML

Для работы через расширение VS Code этот отдельный файл обычно не требуется.

03-diagram-generation.md

Настройка PlantUML Server в VS Code

1. Откройте настройки VS Code:

   Ctrl+Shift+P → Preferences: Open User Settings (JSON)
   

2. Добавьте в settings.json:

   {
     "plantuml.server": "https://www.plantuml.com/plantuml",
     "plantuml.render": "PlantUMLServer",
     "plantuml.urlFormat": "svg",
     "plantuml.urlResult": "MarkDown"
   }

   Если в файле уже есть настройки, добавьте только эти строки, соблюдая запятые.

   После этого расширение будет использовать официальный сервер PlantUML для предварительного просмотра и экспорта. Параметр urlFormat задаёт формат изображения, а urlResult: "MarkDown" — готовую Markdown-разметку.

Создание URL для Markdown

1. Откройте файл .puml.

2. Поставьте курсор внутрь диаграммы, между:

   @startuml
   ...
   @enduml

3. Нажмите правой кнопкой мыши внутри редактора.

4. Выберите:

   PlantUML: Generate URL for Current Diagram
   

   Для всех диаграмм текущего файла выберите:

   PlantUML: Generate URLs for Current File Diagrams
   

   Эти команды присутствуют в контекстном меню PlantUML-файлов.

5. В нижней панели Output появится готовая строка:

   ![Название диаграммы](https://www.plantuml.com/plantuml/svg/ENCODED "Название диаграммы")

   Расширение выводит результат в формате Markdown в панель Output. Скопируйте всю строку и вставьте её в нужное место файла .md.

Markdown-просмотр или GitHub загрузит SVG непосредственно с сервера PlantUML. После изменения исходного .puml URL нужно создать заново и заменить в Markdown, поскольку исходный текст диаграммы закодирован внутри адреса.

Важно: официальный сервер получает содержимое диаграммы. Код в URL сжат и закодирован, но не защищён как секретные данные, поэтому публичный сервер не следует использовать для конфиденциальных схем.