mcpField
D
documentation-patterns

documentation-patterns

github.com/thalysjuvenal开发19351 次安装7 周前更新
代码仓库

关于 documentation-patterns

documentation-patterns 是根据 ADVPL/TLPP 源代码生成 Protheus 标准技术文档的技能。它提供函数头注释、完整例程规格和 REST 端点文档模板，并从代码及可用的 git 历史中提取信息。

主要功能

  1. 01函数和方法头注释模板
  2. 02完整例程规格模板
  3. 03REST 端点文档模板
  4. 04提取代码信息与依赖项
  5. 05利用可用的 git 历史

适用场景

  1. 01为代码添加 Protheus.doc 头注释
  2. 02记录例程行为与依赖项
  3. 03编写 REST 端点文档

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/thalysjuvenal/advpl-specialist --skill documentation-patterns

安装后在 Claude Code 中输入/documentation-patterns确认已加载。

附带文件reference.md

详细介绍

ADVPL/TLPP 文档模式

此技能提供模板和生成流程，用于将 ADVPL/TLPP 源代码转换为符合 Protheus 标准的技术文档。涵盖三种输出类型：用于单个函数/方法的 header Protheus.doc 注释块、full Markdown 例程规格说明（目标、模块、读写表、MV_* 参数、入口点、执行流程、依赖项、变更历史），以及 api REST 端点文档（身份验证、路径/查询参数、请求正文、响应架构）。

当用户要求按照 TOTVS 约定为现有代码生成或添加文档（包括头部注释、完整例程规格说明或 API 文档）时，启用此技能。此流程会读取目标文件，从代码本身提取函数/参数/表/MV_* 用法/入口点/依赖项；在 git 历史可用时，会交叉核对作者和变更日志，然后填充相应模板。

此技能不涵盖面向用户以通俗对话语言解释代码（参见 code-explanation）、查询原生函数签名以准确填写文档（参见 protheus-reference），也不涵盖说明例程中嵌入式 SQL 宏的语义（参见 embedded-sql）。

参考文件阅读时机
reference.md始终阅读——三种文档类型的模板（header/full/api）和生成流程

评论

支持 Markdown