automated-documentation-for-java README

Это расширение для автоматической генерации технической внутренней документации для файлов Java.

Для работы расширения требуется: 0. Установить расширение в Visual Studio Code из магазина расширений

1. Установить Ollama на устройство, где будет запущено расширение
2. Установить в Ollama модель phi3:instruct с помощью команды в терминале ollama run phi3:instruct
3. Создать профиль в базе данных Subabase
4. В базе данных выполнить скрипты из файла scrip.sql, чтобы создать таблицу для хранения файлов проекта и функцию для поиска релевантных частей проекта
5. В Supabase пройти в Project Settings -> API. Скопировать project URL и API key.
6. Создать файл doc.json в корне Java проекта и заполнить его:

{

"supabaseKey": "<API key>",

"supabaseUrl": "https://<URL>.supabase.co"

}

После этого вам доступна функциональность:

1. При нажатии на папку проекта появляется опция Load The Folder to Memory. Нажмите на нее, чтобы загрузить файлы в векторную базы данных. Это нужно для того, чтобы в дальнешем языковая модель опиралась на информацию о проекте при ответе на запросы, и не выдавала галлюцинации

2. При нажатии на конкретный Java файл появляется опция Generate a Documentation File. Нажмите на нее, чтобы сгенерировать файл с внутренней документацией с помощью локально работающей модели.