用途:为指定代码文件添加教学式注释,使其成为学习资源。未提供文件时,会要求用户提供文件,并给出编号的相近匹配列表供快速选择。
主要能力:面向初学者、中级和高级读者调整讲解深度;初学者获得基础解释,中级用户获得实践要点与最佳实践,高级用户获得性能、架构、语言内部机制等更深背景;仅在有助于理解时温和提出改进建议。
使用方式:以斜杠命令调用,例如 /add-educational-comments #file:output_name.py Comment Detail = 1, Repetitiveness = 1, Line Numer = no。可配置项包括:File Name(必填)、Comment Detail(1-3,默认2)、Repetitiveness(1-3,默认2)、Educational Nature(默认 Computer Science)、User Knowledge(1-3,默认2)、Educational Level(1-3,默认1)、Line Number Referencing(yes/no,默认yes)、Nest Comments(yes/no,默认yes)、Fetch List(可选权威参考URL)。缺失项使用默认值,明显拼写错误按上下文解释。
行数规则:默认将文件扩充到原长度的125%,新增教学注释不超过400行;文件超过1000行时目标不超过300行;已处理过的文件改为修订现有注释,不再追求125%。
限制与规则:编辑前确定并保持文件编码不变;仅使用标准QWERTY键盘字符,不使用表情或特殊符号;保留原换行风格(LF或CRLF);单行注释保持单行;遵循语言要求的缩进风格;不得破坏命名空间、导入、模块声明或编码头,避免语法错误(如 PEP 263 的 Python 编码错误)。启用行号引用时,每条新注释以 Note <编号> 开头。
适用场景:希望把现有代码转化为教学材料、帮助不同水平读者理解代码概念与设计取舍时使用。其他细节暂未提供。