SuperAPI AI 工具集

documentation-patterns

编程与开发

查看项目

更新于 10-16 02:09

技能介绍

用途

documentation-patterns 用于把 ADVPL/TLPP 源码转换为符合 TOTVS Protheus 规范的技术文档。当用户要求为已有代码生成或补充文档,并希望遵循 TOTVS 惯例时,可启用该技能,涵盖头部注释、完整例程说明和 API 文档三类场景。

主要能力

该技能提供三种输出类型:

  1. 头部 Protheus.doc 注释块:针对单个函数或方法生成,包含 @type、@param、@return 等标签。
  2. 完整 Markdown 例程说明:覆盖目标、模块、读取与写入的表、MV_* 参数、入口点、执行流程、依赖关系以及变更历史。
  3. REST API 端点文档:描述认证、路径与查询参数、请求体以及响应模式。

使用方式

该技能附带模板与一套生成流程。流程包括:读取目标文件;从代码本身提取函数、参数、表、MV_* 用法、入口点和依赖;在可用时交叉核对 git 历史以确定作者与变更记录;然后填充相应的文档模板。使用前需阅读 reference.md,其中包含三种文档类型(header/full/api)的模板以及生成过程。

适用场景

适用于 ADVPL/TLPP 代码的文档化工作,尤其是需要产出符合 Protheus 标准的头部注释、完整例程说明或 API 文档时。

限制

该技能不覆盖以下情况:以通俗对话语言面向受众解释代码(应参考 code-explanation);查询原生函数签名以准确填写文档(应参考 protheus-reference);记录例程内嵌 SQL 宏的语义(应参考 embedded-sql)。

其他具体信息,如安装方式、收费情况、支持平台或实际效果,资料中暂未提供。