×
¥
查看详情
🔥 会员专享 文生文 其它

后端函数注释生成专家

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

🎯 可自定义参数(3个)

函数代码
需要生成注释的函数代码
编程语言
函数使用的编程语言
注释详细程度
注释的详细程度要求

🎨 效果示例

函数注释: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 应为非负数;若为负值将导致运行时错误。

示例详情

📖 如何使用

30秒出活:复制 → 粘贴 → 搞定
与其花几十分钟和AI聊天、试错,不如直接复制这些经过千人验证的模板,修改几个 {{变量}} 就能立刻获得专业级输出。省下来的时间,足够你轻松享受两杯咖啡!
加载中...
💬 不会填参数?让 AI 反过来问你
不确定变量该填什么?一键转为对话模式,AI 会像资深顾问一样逐步引导你,问几个问题就能自动生成完美匹配你需求的定制结果。零门槛,开口就行。
转为对话模式
🚀 告别复制粘贴,Chat 里直接调用
无需切换,输入 / 唤醒 8000+ 专家级提示词。 插件将全站提示词库深度集成于 Chat 输入框。基于当前对话语境,系统智能推荐最契合的 Prompt 并自动完成参数化,让海量资源触手可及,从此彻底告别"手动搬运"。
即将推出
🔌 接口一调,提示词自己会进化
手动跑一次还行,跑一百次呢?通过 API 接口动态注入变量,接入批量评价引擎,让程序自动迭代出更高质量的提示词方案。Prompt 会自己进化,你只管收结果。
发布 API
🤖 一键变成你的专属 Agent 应用
不想每次都配参数?把这条提示词直接发布成独立 Agent,内嵌图片生成、参数优化等工具,分享链接就能用。给团队或客户一个"开箱即用"的完整方案。
创建 Agent

✅ 特性总结

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

🎯 解决的问题

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

🕒 版本历史

当前版本
v2.1 2024-01-15
优化输出结构,增强情节连贯性
  • ✨ 新增章节节奏控制参数
  • 🔧 优化人物关系描述逻辑
  • 📝 改进主题深化引导语
  • 🎯 增强情节转折点设计
v2.0 2023-12-20
重构提示词架构,提升生成质量
  • 🚀 全新的提示词结构设计
  • 📊 增加输出格式化选项
  • 💡 优化角色塑造引导
v1.5 2023-11-10
修复已知问题,提升稳定性
  • 🐛 修复长文本处理bug
  • ⚡ 提升响应速度
v1.0 2023-10-01
首次发布
  • 🎉 初始版本上线
COMING SOON
版本历史追踪,即将启航
记录每一次提示词的进化与升级,敬请期待。

💬 用户评价

4.8
⭐⭐⭐⭐⭐
基于 28 条评价
5星
85%
4星
12%
3星
3%
👤
电商运营 - 张先生
⭐⭐⭐⭐⭐ 2025-01-15
双十一用这个提示词生成了20多张海报,效果非常好!点击率提升了35%,节省了大量设计时间。参数调整很灵活,能快速适配不同节日。
效果好 节省时间
👤
品牌设计师 - 李女士
⭐⭐⭐⭐⭐ 2025-01-10
作为设计师,这个提示词帮我快速生成创意方向,大大提升了工作效率。生成的海报氛围感很强,稍作调整就能直接使用。
创意好 专业
COMING SOON
用户评价与反馈系统,即将上线
倾听真实反馈,在这里留下您的使用心得,敬请期待。
加载中...
📋
提示词复制
在当前页面填写参数后直接复制: