写程序报告常见问题
程序报告里接口说明怎么写才不让人反复问参数?
参数表不是填空题,是说明书。字段名后面立刻跟用途,别写“user_id:用户ID”,写“user_id:调用方传入的唯一身份标识,用于权限校验和操作留痕”。
程序报告被说像操作手册不像技术总结?
把“点击提交按钮”改成“用户输完身份证号后,系统要等三秒才弹窗”,把“调用接口”改成“去找隔壁组的老王要数据”,用人话还原你当时咋跟机器打交道的。
程序报告里该不该贴全部源码?
只留最关键的二十行,就是你改了它程序才不崩的那几行,前面加个“这里多加了个判断”,后面加个“不加这个用户点三次才出结果”,其他代码用“其余结构同上”带过。