代码 Markdown 文档生成助手
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_71025fdb/mdskdjskshdskh。
技能介绍
要解决什么问题
仓库里往往只有 .cs、.py 等脚本和零散注释,没有可读的 API 说明。人工补 Markdown 既慢,又容易漏掉访问级别、参数含义和类之间的继承关系。这个助手把上传的源码当作唯一输入,按固定流程产出可直接放进文档站的 .md 文件。
它如何工作
对话开始时会维护 {fileList}(待处理文件)、{Extra needs}(额外整理需求)和 {output filelist}(待导出的 MD 文本)。你上传一个或多个 {filename} 后,助手会逐文件解读代码与注释,再进入构建阶段:
- 为每个文件生成独立 MD,或按你的需求合并(例如只写
RangeWeapon、HandToHandWeapon两个子类,并简要说明父类Weapon) - 文档里用表格列出属性(类型、访问级别、含义;引用类型在说明里标注)和方法(访问级别、参数说明)
- 原代码无注释时,助手会基于语义补解释,并在句末标注
(这个为ai自行注释),便于和人工注释区分
最后遍历 {output filelist},在 {outputPath}(未指定则用默认路径)写出 {名称.md}。助手可读你上传的文件,不能改写磁盘上的源文件。
适用边界
- 面向「从代码反推文档」,不是替代你已有的产品 PRD 或架构决策说明
- 复杂
{Extra needs}会被拆成多条再执行,输出份数与结构以对话里确认的需求为准 - Markdown 语法可参考 markdown.com.cn,生成风格偏开发参考手册而非教程叙事
使用场景
- 维护多个同类脚本(如武器子类)时,要求只导出一份 MD,并写清父类与子类继承关系
- 接手仅有 `.py` / `.cs` 且无 README 的模块,需要从注释与代码结构生成属性、方法表格
- 版本发布前要把若干上传的脚本整理成可放进文档站的开发参考页
- 用户提出「只文档化部分文件」或合并输出时,按 Extra needs 指定结构而非一文件一 MD
适合人员
- 负责 Unity/C# 玩法代码的工程师,需要把 Weapon 基类与 RangeWeapon、HandToHandWeapon 等子类写进同一份参考文档
- 开源仓库维护者,贡献者只交源码,你要从上传文件生成带访问级别与参数说明的 MD API 页
- 带新人熟悉老项目的技术负责人,希望从现有脚本快速得到类属性、方法表格供内部分享
- 小团队没有独立文档流水线,只能上传单文件或多脚本并指定 `{outputPath}` 批量导出 `.md`