DocAgent的Web界面是其核心交互方式,提供以下主要功能:
- 项目配置:设置代码库路径(需绝对路径)、选择文档风格/详细程度等参数
- 实时监控:可视化显示文档生成进度、错误日志和预览结果
- 交互控制:支持暂停/继续生成、动态调整参数等操作
- 文档评估:通过独立端口(5001)访问质量评估界面,基于AST分析文档完整性
文档生成操作流程:
- 启动Web服务:
python run_web_ui.py --host 0.0.0.0 --port 5000
- 浏览器访问
http://localhost:5000
- 在界面输入代码库路径(如
/home/user/projects/repo
) - 设置生成参数(如max_tokens、temperature等)
- 点击”开始生成”按钮
对于远程服务器,需要通过SSH隧道连接:ssh -L 5000:localhost:5000 user@host
本答案来源于文章《DocAgent:自动生成Python代码文档的智能工具》