代码教学注释

原名:add-educational-comments

为指定代码补充解释设计意图和关键概念的教学型注释。

中文 Skills 技能说明

适合培训代码、示例项目或复杂算法说明。注释解释“为什么”,不逐行复述语法;修改前先确认目标文件和受众,不改变程序行为,也不在注释中暴露凭据或内部信息。

上游能力依据

上游原始适用说明:Add educational comments to the file specified, or prompt asking for file to comment if one is not provided.

上游 SKILL.md 主要章节(保留原文标题):

使用边界

先读取项目约定、依赖版本和现有测试,再提出最小改动。写文件、运行脚本、提交代码或发布前应检查差异并保留回退路径。

作者、翻译与许可证

原作者
GitHub, Inc. 与 awesome-copilot contributors
中文翻译
CEOFans翻译
许可证
MIT
上游来源
https://github.com/github/awesome-copilot/tree/3f0bba475ec40b9680e1d0311b9caffeec5ad4c3/skills/add-educational-comments

适用范围

平台:linux、macos、windows;标签:软件开发、代码教学注释

安全提示

基础静态扫描不等于绝对安全。技能可能调用命令、浏览器、云服务或本地文件,请在最小权限环境中使用,高风险操作必须人工确认。

如发现侵权、许可证或安全问题,可在本页前台提交投诉,管理员复核后可立即下架。