程序报告常见问答
程序报告里异常处理怎么写才不像抄API文档?
先写你真遇到过哪三类崩法,再写当时怎么拦、怎么记、怎么兜底。每类崩法配一行日志截取,再加半句人话解释这行日志意味着什么。别罗列所有try-catch,只写改过三次以上的那段。异常流要和主流程线并排写,让人一眼看出哪儿容易断、断了怎么续。
程序报告中性能数据怎么呈现才不被质疑注水?
测三轮:空载、常态、峰值,每轮截图命令行输出,标出硬件环境。数据表只留响应时间、吞吐量、错误率三栏,其余全砍。峰值数据后面必须手写一行备注,写清楚压测时哪块资源先顶不住。数字不写小数点后三位,写到实际监控能分辨的最小单位。
程序报告里的接口清单怎么排才方便下游直接对接?
按调用频次从高到低排,每条接口顶格写路径,下面缩进两格写请求方法、必填参数、返回成功结构体字段名。失败返回只写HTTP状态码+一句话原因,不写错误码表。字段名用代码里真实变量名,不翻译成中文。参数类型写string/int/bool,不写“字符串类型”。