Генерація документації в Laravel за допомогою штучного інтелекту

Docudoodle — це пакет генератора документації для PHP у Laravel, який аналізує ваш код і створює документацію за допомогою обраного вами штучного інтелекту. Docudoodle допомагає глибше зрозуміти ваш код та може стати в нагоді при документуванні старого або вже існуючого коду, з яким ви щойно почали працювати

Приклад згенерованої документації за допомогою штучного інтелекту та Docudoodle

Після встановлення пакета ви зможете згенерувати документацію за допомогою Artisan-команди. Готова документація буде доступна у папці documentation/ вашого проєкту:

php artisan docudoodle:generate

Ви можете обрати модель на свій смак, адже проєкт пропонує конфігураційні опції для OpenAI, Claude, Gemini та Ollama. Ось налаштування пакета на момент написання:

return [
    'openai_api_key' => env('OPENAI_API_KEY', ''),
    'claude_api_key' => env('CLAUDE_API_KEY', ''),
    'default_model' => env('DOCUDOODLE_MODEL', 'gpt-4o-mini'),
    'max_tokens' => env('DOCUDOODLE_MAX_TOKENS', 10000),
    'default_extensions' => ['php', 'yaml', 'yml'],
    'default_skip_dirs' => ['vendor/', 'node_modules/', 'tests/', 'cache/'],
    'ollama_host' => env('OLLAMA_HOST', 'localhost'),
    'ollama_port' => env('OLLAMA_PORT', '11434'),
    'gemini_api_key' => env('GEMINI_API_KEY', ''),
    'default_api_provider' => env('DOCUDOODLE_API_PROVIDER', 'openai'),
];

# Головні особливості

Автоматичне генерування документації: Легко генерує документацію для PHP-файлів, аналізуючи їхній вміст.
Гнучка інтеграція зі штучним інтелектом: Вибір між потужним хмарним API OpenAI, API Claude, Google's Gemini API або локальна робота з моделями Ollama для повної конфіденційності.
Підтримка Ollama: Генерування документації повністю офлайн за допомогою ваших власних локальних моделей Ollama — ідеально для приватних кодових баз або коли потрібно працювати без інтернету.
Налаштування: Легко конфігуруйте вихідні каталоги, папки для збереження та інші параметри відповідно до вашого робочого процесу.
Командний інтерфейс: Має простий скрипт командного рядка для швидкого генерування документації.

Дізнайтеся більше про цей пакет, отримайте повні інструкції зі встановлення та перегляньте джерельний код на GitHub. Розробка пакета також містить кілька прикладів, щоб ви могли ознайомитися з фінальною документацією.