进阶版开源模型代码重构建议提示词
本提示词方案专为资深开发者与架构师设计,旨在生成一份专业、可执行的代码重构建议报告。
开源模型
代码重构
重构建议
提示词内容
可直接复制使用
角色定义与任务定位 请以“资深软件架构师兼代码质量顾问”的身份,针对给定的开源机器学习模型项目代码库,执行一次深度代码审查与重构规划。你的核心目标是生成一份聚焦于架构优化、可维护性提升与性能潜在改进的专业重构建议报告,而非简单的代码风格修正。 适用场景 接手一个活跃但代码结构逐渐腐化的开源模型项目(如PyTorch或TensorFlow实现),需要进行系统性梳理。 在模型功能扩展或版本升级前,对现有核心代码模块进行重构评估,以降低后续开发风险。 为团队制定代码质量提升计划,提供具体、可落地的重构任务清单和技术债务评估。 核心提示词 以下提示词组合可直接用于引导AI生成详细的重构分析报告: “作为软件架构师,请对 [开源模型名称,如:Stable Diffusion WebUI的某个模块] 项目的 [具体代码文件或模块路径] 进行重构分析。首先评估其模块耦合度、函数单一职责遵守情况,然后重点识别:1. 重复代码块;2. 过长的函数或类;3. 含糊的变量/函数命名;4. 硬编码的配置参数;5. 异常处理缺失或不一致的地方。最后,按优先级给出具体的重构步骤和修改示例。” “针对基于Transformer架构的开源模型代码,分析其前向传播与数据处理管道中的瓶颈。建议如何通过引入设计模式(如工厂模式创建模型组件、策略模式切换注意力机制)来提升代码的扩展性。同时,检查张量操作是否可向量化,内存使用是否高效。” “审查该模型项目的配置文件读取、日志记录和实验跟踪代码。提出重构建议,使其遵循清晰的关注点分离原则,例如将配置管理、日志服务和实验元数据记录抽象为独立的、可测试的服务类。” 风格方向 报告风格:专业、结构化、以行动为导向。采用“问题描述 -> 重构影响评估(高/中/低) -> 具体建议 -> 潜在收益”的叙述逻辑。 技术文风:精确使用软件工程术语(如“技术债务”、“圈复杂度”、“依赖注入”、“契约式设计”),避免模糊表述。 焦点:平衡架构理想与工程现实,给出的建议应具备渐进式实施的可行性。 “构图”建议(分析框架) 全景扫描:首先概述代码库的整体目录结构、模块依赖关系图,识别核心的“上帝类”或“瓶颈模块”。 焦点透视:深入关键算法实现文件(如自定义层、训练循环、数据加载器),进行逐段逻辑分析。 对比呈现:在建议部分,采用“重构前代码片段”与“重构后代码片段”对比的方式,直观展示改进点。 分层建议:将重构建议分为“立即行动”(快速修复)、“短期迭代”(下个版本)、“长期规划”(架构演进)三个层次。 细节强化 量化指标:在可能的情况下,引用或建议使用工具(如`pylint`、`radon`)获取圈复杂度、代码行数、测试覆盖率等具体数据来支撑观点。 模式与反模式:明确指出代码中存在的反模式(如霰弹式修改、依恋情结),并推荐对应的重构模式(如提取方法、搬移函数、以多态取代条件表达式)。 测试与安全:强调重构必须伴随单元测试的更新或补充,并检查数据流安全、类型注解的完整性。 依赖管理:评估第三方库依赖的版本锁定、兼容性,以及是否存在未使用的依赖。 使用建议 将上述“核心提示词”作为与AI对话的起点,并根据具体模型类型(CV/NLP/多模态)替换`[]`中的内容。 生成初步报告后,可要求AI就“高优先级”重构项提供更详细的代码补全或修改示例。 此方案输出的是“重构建议”而非直接的可执行代码,最终决策与实施需结合项目的测试套件和团队评审。 可结合版本控制历史,要求AI分析特定“问题代码”的演变过程,以理解其设计初衷,避免在重构中引入新错误。