¥
立即购买

后端函数注释生成专家

41 浏览
2 试用
0 购买
Dec 1, 2025更新

本提示词专为后端开发场景设计,能够根据函数代码自动生成专业、准确的技术注释。通过深度分析函数结构、参数类型和业务逻辑,生成符合技术文档标准的注释内容,包含函数功能描述、参数说明、返回值解释等关键要素,帮助开发团队提升代码可读性和维护性,确保技术文档的一致性和专业性。

函数注释:fetch_users

def fetch_users(db, filters: Dict[str, Any], page: int, page_size: int, sort_by: str = "created_at", order: str = "desc") -> Dict[str, Any]:
    """
    获取用户列表,支持基于允许字段的筛选、排序与分页,并返回分页元数据。

    函数使用参数化 SQL(PostgreSQL 语法)构建查询:先统计总数,再按分页返回
    id、email、role、status、created_at、last_login 等字段。

    Args:
        db: 数据库访问对象,需实现以下方法:
            - query_scalar(sql: str, params: List[Any]) -> int
            - query_all(sql: str, params: List[Any]) -> List[Any]
            使用 %s 作为参数占位符。
        filters: 筛选条件字典,支持的键:
            - status: 精确匹配用户状态(=)。
            - email: 邮箱模糊匹配(ILIKE,包含式,自动加两侧通配符)。
            - role: 精确匹配用户角色(=)。
            - created_from: 创建时间下界(含),作用于 created_at(>=)。
            - created_to: 创建时间上界(含),作用于 created_at(<=)。
            值为 None 或空字符串的条目,以及未在允许列表中的键将被忽略。
        page: 页码,从 1 开始;小于 1 时按 1 处理。
        page_size: 每页条数;<= 0 或 > 100 时按 20 处理。
        sort_by: 排序字段,限定为 {'created_at', 'email', 'last_login'};非法值回退为 'created_at'。
        order: 排序方向,'asc' 或 'desc'(大小写不敏感);非法值回退为 'desc'。

    Returns:
        Dict[str, Any]: 结果字典,包含:
            - items (List[Any]): 当前页记录列表,为底层驱动返回的行对象集合,
              列包含 id、email、role、status、created_at、last_login。
            - page (int): 实际页码。
            - page_size (int): 实际每页条数。
            - total (int): 符合条件的总记录数。
            - has_next (bool): 是否存在下一页(依据 offset + 当前页记录数 < total 计算)。

    Raises:
        数据库访问相关异常: 由 db.query_scalar 或 db.query_all 调用过程中抛出,原样向上抛出。
    """

功能说明

构建并执行对 users 表的参数化查询,支持按 status、email、role、created_at 时间范围等条件进行筛选;按 created_at、email、last_login 字段进行升降序排序;并提供页码与页大小控制的分页查询能力。函数返回当前页数据及分页元信息(总数、是否有下一页)。

参数说明表格

参数名 类型 描述
db Any 数据库访问对象,需实现 query_scalar 与 query_all,使用 %s 占位符进行参数绑定。
filters Dict[str, Any] 筛选条件字典;允许键:status、email、role、created_from、created_to;None 或空字符串值会被忽略。
page int 页码,从 1 开始;小于 1 时按 1 处理。
page_size int 每页条数;<= 0 或 > 100 时按 20 处理。
sort_by str 排序字段:created_at、email、last_login;非法值回退为 created_at。
order str 排序方向:asc 或 desc(大小写不敏感);非法值回退为 desc。

返回值说明

  • 类型:Dict[str, Any]
  • 含义:
    • items: List[Any],当前页记录列表(具体行类型与数据库驱动实现相关),列包含 id、email、role、status、created_at、last_login。
    • page: int,实际页码。
    • page_size: int,实际每页条数。
    • total: int,满足筛选条件的总记录数。
    • has_next: bool,是否存在下一页,依据 offset + len(items) < total 计算。

注意事项

  • 仅允许的筛选键会参与条件构造;未允许的键或空值会被忽略。
  • 排序字段与方向仅在允许集合内生效,否则回退到默认值。
  • 邮箱筛选使用 ILIKE 和包含式匹配(%value%),依赖 PostgreSQL 语法。
  • SQL 参数使用 %s 占位符,需与底层数据库驱动的参数化约定匹配。

calculateAmount

/**
 * 计算订单汇总金额。
 *
 * 基于商品金额与运费,按优惠券、最小消费与有效期规则计算商品与运费的折扣,
 * 在折扣后金额上按给定税率计算税额,并返回包含各项明细与应付总额的汇总结果。
 *
 * 规则概述:
 * - 负数的商品金额、运费会按0处理;税率被限制在[0, 1]区间。
 * - 优惠券仅在未过期且订单金额(商品+运费)达到最小消费时生效。
 * - 百分比券仅作用于商品金额:折扣=itemsTotal*pct,结果四舍五入到分(HALF_UP)。
 * - 固定额券先抵扣商品的剩余应付,剩余额度再抵扣运费,均不超过各自金额。
 * - 税额=(折扣后商品+折扣后运费)*税率;税额到分,按roundUp选择进位(CEILING)或四舍五入(HALF_UP)。
 * - 最终总额=应税额+税额,到分四舍五入(HALF_UP)。
 *
 * @param itemsTotal 订单商品总金额,非空;若为负数按0处理。
 * @param shippingFee 运费金额,非空;若为负数按0处理。
 * @param coupons 可选的优惠券列表;允许为null或包含null元素。过期券或不满足最小消费的券将被忽略。
 * @param taxRate 税率,非空;小于0按0处理,大于1按1处理。
 * @param roundUp 是否对税额按分位向上取整(true使用CEILING;false使用HALF_UP)。
 * @return 包含各项原始金额、折扣、税率/税额与应付总额的订单汇总对象,非空。
 * @throws NullPointerException 当itemsTotal、shippingFee或taxRate为null时抛出。
 */

功能说明

根据输入的商品金额与运费,按优惠券类型、最小消费门槛和有效期计算折扣;在折扣后金额上应用税率计算税额(支持税额进位或四舍五入),并返回包含原始金额、折扣、税率、税额及最终应付总额的汇总结果。百分比优惠仅作用于商品金额;固定额优惠优先抵扣商品,剩余再抵扣运费。负数输入被视为0,税率被限制在[0,1]区间。

参数说明表格

参数名 类型 说明
itemsTotal java.math.BigDecimal 商品总金额,非空;若小于0则按0处理。参与百分比券折扣基数。
shippingFee java.math.BigDecimal 运费金额,非空;若小于0则按0处理。固定额券在抵扣商品后可继续抵扣运费。
coupons java.util.List<PricingService.Coupon> 可选优惠券列表;可为null或包含null元素。仅未过期且达到最小消费(商品+运费)时生效。
taxRate java.math.BigDecimal 税率,非空;小于0按0,超过1按1处理。应用于折扣后的商品与运费之和。
roundUp boolean 税额取整方式:true则税额到分向上取整(CEILING),false则四舍五入(HALF_UP)。

返回值说明

  • 类型:PricingService.OrderSummary
  • 含义:
    • itemsTotal:输入的商品金额,保留两位小数(HALF_UP)。
    • shippingFee:输入的运费金额,保留两位小数(HALF_UP)。
    • discountOnItems:对商品金额的总折扣,包含百分比和固定额对商品部分的抵扣,保留两位小数(HALF_UP)。
    • discountOnShipping:对运费的总折扣(仅来源于固定额券剩余额度),保留两位小数(HALF_UP)。
    • taxRate:实际用于计算的税率(已限制在[0,1]区间)。
    • tax:按折扣后金额计算的税额,保留两位小数;取整方式由roundUp决定。
    • grandTotal:应付总额=折扣后金额+税额,保留两位小数(HALF_UP)。

注意事项

  • itemsTotal、shippingFee、taxRate为必填且非空,否则抛出NullPointerException。
  • 优惠券生效依赖当前时间判断有效期(Instant.now);已过期的优惠券被忽略。
  • 折扣不会使商品或运费为负;对商品与运费的折扣分别不超过各自原始金额。

RefreshToken

// RefreshToken 获取或刷新指定用户的活动令牌。
// 若存在距过期时间超过 10 分钟的活动令牌,则直接返回其 ID;
// 否则撤销旧令牌(若存在)并创建新令牌:
//   - ID: 16 字节随机数据的十六进制编码(32 个字符)
//   - Secret: 32 字节随机数据的十六进制编码(64 个字符)
//   - ExpiresAt: now + 2 小时
//   - CreatedAt: now
// 返回新建或现有令牌的 ID。
// 当 repo 为空、userID 为空、随机数生成失败或保存失败时返回错误。

功能说明: 为指定用户返回可用的令牌 ID。已有令牌若在 10 分钟内即将过期则被替换,新令牌会持久化保存,过期时间基于传入的 now 设置为 2 小时后。

参数说明: | 参数名 | 类型 | 说明 | |---|---|---| | ctx | context.Context | 上下文,用于仓库调用的取消和超时控制 | | repo | TokenRepo | 令牌存储接口,用于查询、保存与撤销 | | userID | string | 目标用户标识,不能为空 | | now | time.Time | 时间基准,用于计算剩余有效期和设置过期时间 |

返回值说明:

  • string:令牌 ID(可能是现有令牌或新签发的令牌)
  • error:当参数非法、随机数生成失败或保存失败时返回错误

注意事项:

  • GetActiveToken 与 RevokeToken 的调用错误被忽略,不影响主流程返回。
  • 返回值仅包含令牌 ID,不包含 Secret。
  • 过期阈值为 10 分钟,新令牌有效期为 2 小时,均基于传入的 now 计算。

randomHex

// randomHex 生成包含 2n 个十六进制字符的随机字符串。
// 使用加密安全的随机源生成 n 字节数据并进行十六进制编码。
// 当 n 为 0 时返回空字符串;当随机源读取失败时返回错误。

功能说明: 生成以十六进制表示的随机字符串,适用于令牌 ID、密钥等需要高熵值的场景。

参数说明: | 参数名 | 类型 | 说明 | |---|---|---| | n | int | 生成的随机字节数,结果字符串长度为 2n |

返回值说明:

  • string:由 n 字节随机数据编码而成的十六进制字符串(长度 2n)
  • error:随机数读取失败时返回

注意事项:

  • 使用 crypto/rand 作为随机源,具备加密安全性。
  • n 应为非负数;若为负值将导致运行时错误。

示例详情

解决的问题

以分钟级、一键式的方式,将后端函数代码转化为可直接合并的高标准注释与说明。统一团队写作风格、减少评审与交接成本、提升代码可读性与维护效率;支持多编程语言与不同详略程度,覆盖新功能开发、重构、遗留代码治理和技术文档补全等核心场景,最终实现更快交付、更少返工和更高质量。

适用用户

后端开发工程师

在新功能提交前,一键生成函数注释与参数说明,统一风格;重构旧模块时自动补全文档,减少沟通与回归风险。

技术文档负责人

批量规范化函数注释,快速形成可读的技术说明与表格;协助建立统一标准,缩短评审与发布文档时间。

架构师/项目负责人

用清晰注释约束模块边界与使用方式,降低跨团队误解;在代码评审中快速发现遗漏与异常处理缺口。

特征总结

根据函数代码轻松生成专业注释,涵盖功能、参数与返回,开箱即用
自动识别函数意图与业务逻辑,输出清晰用途说明,减少误解与返工
一键生成参数用途与约束说明,避免遗漏细节,提升接入与联调效率
自动补充返回含义与异常提示,帮助快速定位问题,规范错误处理流程
按所选语言的注释风格输出,无需手动调格式,直接贴入代码与文档
覆盖微服务、数据处理与接口集成场景,统一注释标准,降低维护成本
支持按详细程度切换输出粒度,满足开发、评审与交付不同阶段需求
严格基于代码生成,不臆测功能与数据,保证合规安全,可用于生产
生成后自检完整性与一致性,减少沟通成本与返工,提高团队交付速度

如何使用购买的提示词模板

1. 直接在外部 Chat 应用中使用

将模板生成的提示词复制粘贴到您常用的 Chat 应用(如 ChatGPT、Claude 等),即可直接对话使用,无需额外开发。适合个人快速体验和轻量使用场景。

2. 发布为 API 接口调用

把提示词模板转化为 API,您的程序可任意修改模板参数,通过接口直接调用,轻松实现自动化与批量处理。适合开发者集成与业务系统嵌入。

3. 在 MCP Client 中配置使用

在 MCP client 中配置对应的 server 地址,让您的 AI 应用自动调用提示词模板。适合高级用户和团队协作,让提示词在不同 AI 工具间无缝衔接。

AI 提示词价格
¥20.00元
先用后买,用好了再付款,超安全!

您购买后可以获得什么

获得完整提示词模板
- 共 640 tokens
- 3 个可调节参数
{ 函数代码 } { 编程语言 } { 注释详细程度 }
获得社区贡献内容的使用权
- 精选社区优质案例,助您快速上手提示词
使用提示词兑换券,低至 ¥ 9.9
了解兑换券 →
限时半价

不要错过!

半价获取高级提示词-优惠即将到期

17
:
23
小时
:
59
分钟
:
59