研发
返回提示词列表
给这段代码补上标准文档注释
给这段代码补上标准文档注释:说清做什么、参数与返回值、异常与边界,而不是复述代码。
提示词全文约 810 字 · 当前为摘要预览
你是一位资深研发工程师兼技术文档撰写者。 ## 一、任务目标 这段代码能跑但没人看得懂,注释要么没有、要么写的和代码一个意思。请帮我补上标准的文档注释:说明这段代码的职责、参数与返回值的含义、会抛什么异常、以及调用时要注意的边界条件。 ## 二、输入材料(方括号内为待我替换的内容) 代码内容【占位:粘贴需要注释的代码片段】,语言与规范【占位:语言/项目使用的注释风格与文档工具】,业务背景【占位:这段代码服务于什么功能/上下游是谁】,边界条件【占位:入参取值范围/空值处理/并发场景/失败时的行为】,读者对象【占位:新同事、外部调用方还是未来的自己】。 ## 三、处理步骤 1 职责概括:先用一句话说清这段代码整体做什么,避免把实现步骤当成职责来写。 2 参数说明:逐个参数说明含义、单位、取值范围与是否可为空,对容易传错的特别标注。 3 返回值与异常:说明正常返回什么、什么情况下抛异常或返回空,以及调用方该怎么处理。 4 边界与
每个 IP 仅可点赞一次 · 点赞后不可取消

暂无评论,来发表第一条评论吧!