SuperAPI AI 工具集

write-doc-examples

写作与研究

查看项目

更新于 10-15 20:12

技能介绍

用途:该技能用于撰写、重写和格式化文档中的代码片段,使其可直接复用或集成到生产级 Java 应用中,同时保持整篇文档的风格一致性。

主要能力:

  1. 保持文档上下文与风格一致:沿用文档前文已有的构建器/工厂模式、命名约定(如 createBaseClient、client、schema、settings、events),子章节在上文基础上增量构建。
  2. 将代码包裹为方法:不呈现散落语句,而是封装为真实的、可复用的方法,如工厂方法 public Client.Builder createBaseClient()、操作类方法 readEvents(Client client, TableSchema schema)、writeEvents(Client client, List<Event> events) 等。
  3. 只保留相关库导入:包含 com.clickhouse.client.api.、com.clickhouse.data.、com.clickhouse.jdbc.* 等,省略常见 JDK 类。
  4. 允许省略明显定义:辅助 DTO 类可不给出完整定义,仅当字段结构对演示库功能(如 POJO 列映射)重要时才提供。
  5. 代码需通过 lint 且达生产级:可关闭资源使用 try-with-resources,兼容 Java 8+,处理空输入与受检异常,使用 4 空格缩进、括号配对。

使用方式:更新文档示例时,先扫描文档前文结构,判断示例意图(配置、查询、插入、流式或错误处理),按文档风格封装为可复用方法,收集所需 com.clickhouse.* 导入,剔除无关样板,最后按方法签名、变量类型、分号、try-with-resources 块做 lint 格式化。

适用场景:ClickHouse Java 客户端文档中涉及客户端配置与实例化、认证与 TLS 变体、POJO 映射(注册、读取、写入)、流式查询与二进制格式读取、带回调的流式插入等示例的改写。

局限:资料未提供该技能的安装命令、收费方式、支持平台及版本要求;其规则针对 Java 与 ClickHouse 客户端库,未说明是否适用于其他语言或库。翻译整理时保留原有代码与类名不变。