Générer de la documentation dans Laravel avec l’IA

Docudoodle est un package générateur de documentation PHP pour Laravel qui analyse votre base de code et crée de la documentation en utilisant l’IA de votre choix. Docudoodle vous aide à mieux comprendre votre base de code et peut vous aider à documenter les bases de code héritées ou existantes avec lesquelles vous venez de commencer à travailler.

Une fois que vous avez installé ce package, vous pouvez générer la documentation à l’aide de la commande Artisan du package. Une fois terminée, la documentation sera disponible dans le dossier de votre projet : documentation/

php artisan docudoodle:generate

Vous pouvez utiliser le modèle de votre choix, le projet offrant des options de configuration OpenAI, Claude, Gemini et Ollama. Voici les options de configuration du package au moment de la rédaction :

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'),
];

Caractéristiques principales

• Génération automatique de documentation : Génère sans effort de la documentation pour les fichiers PHP en analysant leur contenu.
• Intégration flexible de l’IA : Choisissez entre la puissante API cloud d’OpenAI, l’API Claude, l’API Gemini de Google ou exécutez-la localement avec des modèles Ollama pour une confidentialité totale.
• Support Ollama : Générez de la documentation entièrement hors ligne à l’aide de vos propres modèles Ollama locaux - parfait pour les bases de code privées ou lorsque vous devez travailler sans connexion Internet.
• Personnalisable : configurez facilement les répertoires sources, les dossiers de sortie et d’autres paramètres en fonction de votre flux de travail.
• Interface de ligne de commande : inclut un script de ligne de commande simple pour une génération rapide de documentation.

Vous pouvez en savoir plus sur ce package, obtenir des instructions d’installation complètes et consulter le code source sur GitHub. Le référentiel de packages contient quelques exemples afin que vous puissiez prévisualiser ce à quoi vous attendre dans la documentation finale.