通过
搜索
搜索molbal / ai-phpdoc
使用GPT-3写入缺失的PHPDoc注释。
1.0.8
2024-08-04 12:55 UTC
Requires
- php: ^8.1
- openai-php/client: ^0.3.0
- symfony/console: ^6
README
AI PHPDocs
AI PHPDocs是一个使用GPT-3自动为您PHP代码添加缺失的PHPDoc注释的工具。
演示视频：https://youtu.be/bu-fkRyLQaI
示例输出：https://github.com/molbal/abyss-tracker/commit/e4013c7533aa7ca855176ddce9f3563a011cdc0f
先决条件
此包使用OpenAI API。在使用AI PHPDocs之前，您需要将OpenAI API密钥设置为环境变量。
export OPENAI_KEY=...
您可以在https://beta.openai.com/account/api-keys获取API密钥。
安装
要安装AI PHPDocs，运行以下命令
composer global require molbal/ai-phpdoc
用法
要将缺失的PHPDoc注释添加到单个文件，使用以下命令
aiphpdocs file /path/to/file.php
要将缺失的PHPDoc注释添加到文件目录，使用以下命令。默认情况下，它遍历当前目录中的所有文件，但不进入子目录
aiphpdocs dir
您可能需要设置--recursive标志，或使用简写-r进入子目录。
如果您传递另一个变量（无论是否有递归标志），它将将其视为另一个要扫描的目录，而不是工作目录。
aiphpdocs dir -r /somewhere/else
许可证
AI PHPDocs受AGPL-3.0许可证的许可。有关更多信息，请参阅LICENSE。