面向对象组件文档

原名：oo-component-documentation

为类、接口、依赖、生命周期和扩展点生成结构清楚的组件说明。

中文 Skills 技能说明

适合 Java、C#、Python 等面向对象项目的交接和评审。先从源码和测试确认真实行为，再说明公开契约和示例；内部实现、密钥和客户数据不进入公开文档。

上游能力依据

上游原始适用说明：Create or update standardized object-oriented component documentation using a shared template plus mode-specific guidance for new and existing docs.

上游 SKILL.md 主要章节（保留原文标题）：

• Determine the mode first
• Documentation standards
• Shared analysis guidance
• Shared output requirements
• Language-specific optimizations
• Error handling
• Workflow
• Completion criteria

使用边界

先提供真实业务背景、目标受众和可核验资料。输出是工作草稿或决策辅助，不补造客户反馈、经营数据、案例或引用。

作者、翻译与许可证

原作者

GitHub, Inc. 与 awesome-copilot contributors

中文翻译

CEOFans翻译

许可证

MIT

上游来源

https://github.com/github/awesome-copilot/tree/3f0bba475ec40b9680e1d0311b9caffeec5ad4c3/skills/oo-component-documentation

适用范围

平台：linux、macos、windows；标签：内容与写作、面向对象组件文档

安全提示

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

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