菜单
当当前任务创建、修改、调试、修复、重构或扩展 Python 模块、脚本、测试、数据处理代码或 Jupyter notebook 时使用，包括用户只说“fix this Python bug”“refactor this script”“update this notebook”但没提注释的情况。默认只检查本轮任务触及的 `.py`、`.ipynb` 与 notebook 风格 `.py` 文件，并对这些受影响文件做整文件注释补齐：所有命名函数和方法都要有说明，重要函数和关键逻辑写得更详细，同时仍优先遵守项目既有风格，不扫描无关文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | python-jupyter-comment-guard |
| description | 当当前任务创建、修改、调试、修复、重构或扩展 Python 模块、脚本、测试、数据处理代码或 Jupyter notebook 时使用，包括用户只说“fix this Python bug”“refactor this script”“update this notebook”但没提注释的情况。默认只检查本轮任务触及的 `.py`、`.ipynb` 与 notebook 风格 `.py` 文件，并对这些受影响文件做整文件注释补齐：所有命名函数和方法都要有说明，重要函数和关键逻辑写得更详细，同时仍优先遵守项目既有风格，不扫描无关文件。 |
| metadata | {"short-description":"Python/Jupyter 隐式注释守门"} |
让 Codex 在编写或修改 Python 与 Jupyter 内容时，默认把“检查并补齐必要注释”当成交付的一部分，而不是等用户额外提醒。
这个 skill 的职责是做隐式守门：当本轮任务真正触及某个 Python 或 notebook 相关文件时，自动判断该文件的注释是否足够，不足就补齐。它不会扫描整个仓库，也不会把所有代码写成教科书；默认只解释目的、关键约束和难点，如果用户明确要求更详细说明，则按要求提升说明力度。
默认执行规则：
.py、.ipynb 或 notebook 风格 .py 文件，就把“整文件检查并补齐注释”视为代码任务的一部分。当本轮任务满足以下任一条件时默认使用：
.py 文件即使用户主要在修 bug、补功能、做重构或整理 notebook，只要本轮任务触及上述文件，本 skill 仍应介入。
以下情况不应触发：
“当前任务触及文件”只指本轮任务中明确创建、编辑、重写的 Python / notebook 相关文件。
默认包含：
.py.ipynb.py默认不包含：
始终按以下优先级决策：
本 skill 是保底，不是压过真实项目规范的硬编码模板。
Python 路由 还是 Notebook 路由。保底层、重点层、用户加严层。对每个受影响文件，默认检查整文件是否缺少以下内容：
如果缺失，就补齐；如果已经足够，就保持不动。不要因为只改了一小处代码，就顺手大扫除整个仓库；但可以在当前受影响文件内做完整的注释补齐。
默认使用。
以下对象默认允许写得更详细：
重点层的目标是让用户快速读懂整体流程与关键决策，而不是让每一行都带注释。
当用户明确说“写详细注释”“解释清楚”“多写一点说明”“帮助我理解这段代码”时，必须提升注释力度。
此时优先加厚以下位置：
加严时仍要避免废话型注释。详细不等于重复代码表面含义。
读取 references/python-guidance.md。
默认规则：
.py 文件应有文件级说明。优先使用模块 docstring；若项目明显不用 docstring，也可用文件顶部中文块注释。.py 文件，就要对该文件做整文件注释审视，而不是只看改动附近。读取 references/notebook-guidance.md。
默认规则：
读取 references/escalation-rules.md。
在以下情况必须主动增加说明：
读取 references/core-policy.md。
尤其避免：
完成前至少检查以下几点：
只读取需要的文件：
references/core-policy.md：默认目标、优先级、禁止事项、自检规则references/trigger-boundaries.md：隐式触发边界、受影响文件定义、范围控制规则references/python-guidance.md：Python 模块、脚本、函数、变量、测试的注释规则references/notebook-guidance.md：Jupyter notebook 的叙述、代码注释和输出说明references/escalation-rules.md：用户要求更详细时的升级规则examples/prompts.md：触发语和典型请求示例