程序報告常見問答
程序報告里異常處理怎么寫才不像抄API文檔?
先寫你真遇到過哪三類崩法,再寫當時怎么攔、怎么記、怎么兜底。每類崩法配一行日志截取,再加半句人話解釋這行日志意味著什么。別羅列所有try-catch,只寫改過三次以上的那段。異常流要和主流程線并排寫,讓人一眼看出哪兒容易斷、斷了怎么續(xù)。
程序報告中性能數(shù)據(jù)怎么呈現(xiàn)才不被質(zhì)疑注水?
測三輪:空載、常態(tài)、峰值,每輪截圖命令行輸出,標出硬件環(huán)境。數(shù)據(jù)表只留響應(yīng)時間、吞吐量、錯誤率三欄,其余全砍。峰值數(shù)據(jù)后面必須手寫一行備注,寫清楚壓測時哪塊資源先頂不住。數(shù)字不寫小數(shù)點后三位,寫到實際監(jiān)控能分辨的最小單位。
程序報告里的接口清單怎么排才方便下游直接對接?
按調(diào)用頻次從高到低排,每條接口頂格寫路徑,下面縮進兩格寫請求方法、必填參數(shù)、返回成功結(jié)構(gòu)體字段名。失敗返回只寫HTTP狀態(tài)碼+一句話原因,不寫錯誤碼表。字段名用代碼里真實變量名,不翻譯成中文。參數(shù)類型寫string/int/bool,不寫“字符串類型”。