用途:code-docs 用于从代码分析自动生成或更新文档,减少手工编写 README、API 文档和内联注释的工作量。
主要能力:解析目标文件,提取类、方法、属性及其签名,识别依赖与继承关系,查找已有注释;根据方法名、参数、方法体推断用途、行为、可抛出的异常和返回值含义;生成 Markdown 文档,包含参数表、代码示例、异常与边界情况说明;更新内联注释,如 C# 的 XML 注释、JavaScript/TypeScript 的 JSDoc、Python 的 docstring;创建或更新 docs/README.md 索引,按命名空间或模块组织并添加导航结构。
使用方式:激活该技能后,可用自然语言提示触发,例如“Generate documentation for the Services folder”“Document the FlightController class”“Create a README for this project”“Add XML comments to BookingService.cs”“Update docs for the Models folder”。技能会分析代码并生成对应文档文件,同时更新内联注释和索引。
适用场景:新增服务或类需要补文档、为现有项目生成 README、为方法批量添加注释、维护文档与代码同步、帮助新开发者快速了解代码结构。
支持语言:C#(XML 注释)、TypeScript(JSDoc)、JavaScript(JSDoc)、Python(docstrings)、Java(Javadoc),均支持 Markdown 与示例。
限制:资料未提供安装命令、具体运行环境、收费方式、价格、平台支持范围及效果保证;实际生成质量取决于代码可分析程度与注释完整度,生成内容仍需人工核对。