github/create-oo-component-documentation

create-oo-component-documentation 是做什么的？

创建遵循行业最佳实践和架构文档标准的面向对象组件综合标准化文档。

概述

本技能用于生成面向对象组件的完整文档，包括类、接口、继承关系和设计模式等细节。文档模板基于行业标准，确保输出的文档具有高度可读性和一致性。

使用方法

1. 提供组件源代码或项目结构路径。
2. 技能将解析代码中的命名、注释与结构。
3. 生成符合标准的 Markdown 文档。

支持平台

• Claude Code
• Cursor
• Codex
• 其他支持自定义技能的 AI 编码助手

文档模板示例

# 组件名称

## 概述

简要描述组件职责和用途。

## 类结构

### 公共类

- `ClassName` - 描述

### 接口

- `InterfaceName` - 描述

## 继承关系

```mermaid
classDiagram
    ClassA <|-- ClassB
    ClassA : +method()
    ClassB : +overrideMethod()

设计模式

• 模式名称
• 使用场景

依赖项

• 依赖 A
• 依赖 B

## 最佳实践

- 遵循单一职责原则。
- 使用有意义的类名和接口名。
- 保持文档与代码同步。

## 许可

MIT