DeepSeek最佳Python代码注释提示词合集
基础提示词结构
构造一个有效的提示词，可以分三个阶段：第一步，定义角色定位；第二步，固定输入输出格式；第三步，附上具体示例。 下面这个模板可以直接复用，把【你的函数名】和【功能简述】替换成实际内容即可：你是一名资深Python工程师，专注于编写简洁、规范、符合PEP 8标准的文档字符串和内联注释。请为以下Python函数补充完整注释：函数名为【你的函数名】，功能是【功能简述】。要求：① 采用Google风格docstring；② 每个参数、返回值、异常必须说明；③ 函数体内部关键逻辑行添加英文内联注释（# 开头）；④ 不修改原代码结构，仅补充注释。
针对不同场景的优化提示词
方法一：给已有代码补全注释（最常用）
直接把原始代码粘贴进来，加上这句提示：
请在不改动任何代码逻辑和缩进的前提下，为下面这段Python代码补充完整注释。重点说明：【函数为何要校验输入类型而非仅用类型提示】，并在对应校验行后加#注释解释原因。
方法二：生成带中文注释的脚本（适合教学或团队协作）
你正在为新入职同事编写入门脚本。请为以下函数生成中文docstring和中文内联注释，语言直白易懂，避免术语堆砌。特别注意：对涉及time.sleep()、requests.get()等可能阻塞或失败的操作，必须标注超时与重试逻辑的意图。
方法三：批量处理多个函数（需结构化输出）
我将提供3个未注释函数。请按顺序为每个函数生成独立代码块，格式为：
[含完整注释的函数代码]。每个代码块上方用#===【函数名】===分隔。不要合并、不要省略空行、不要添加额外说明文字。
避坑要点与关键指令
① 避免模糊指令。像“加点注释”“写得清楚些”这类说法，模型很难把握尺度。结果往往就是在函数开头写一句“# 处理数据”就草草了事。
② 必须明确指定docstring风格。是Google、NumPy还是reStructuredText？不指明的话，DeepSeek默认采用混合风格，参数对齐会混乱不堪。
③ 如果函数内包含复杂算法，可以追加一句：“在第X行循环中，请用10字以内短语说明该次迭代的核心目的，例如# 收集相邻节点ID”。
④ 【禁止让DeepSeek自行重构代码】——所有提示词中必须包含“不修改原逻辑”“不调整缩进”“不增删变量”这类强约束。否则，它很可能把if-else改写成三元表达式，顺手把你原有的注释都删掉。