AI / 写作与编辑
接口写完了文档还没影,先用现有代码和注释起一份能评审的初稿
下面是接口实现与注释:[路由、参数与代码片段]。请整理成接口文档:用途一句话、请求方法与路径、参数表(名称/类型/必填/默认值/说明)、返回结构与字段含义、错误码与触发条件、调用示例、常见误用。注释里没写清的地方统一标「待补」。
中文原文
参数表按调用顺序排,比按字母排更贴近使用者的阅读路径。