Home Sign Up Sign In
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member  Sign In
V2EX  ›  forgetyes  ›  全部回复第 8 页 / 共 8 页
回复总数  141
1  2  3  4  5  6  7  8  
❮ ❯
2025 年 2 月 23 日
回复了 puzzle9 创建的主题 › 程序员 › 后端的大佬们 你们的接口文档注释写道什么程度呀
既然是接口文档，我建议是不要用代码注释的方式去解释字段，而是分开来写，代码只是一个返回示例即可；另外是否需要每个字段都解释具体还得看场景，如果是公司内部前后端协作，有个固定的风格习惯后，一些通用字段（比如 id 、total ）可以不用每个接口都解释，如果是公开 API 或者交付给外部的 API 越详细越好。
1  2  3  4  5  6  7  8  
❮ ❯
About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   940 Online   Highest 6679   ·     Select Language
创意工作者们的社区
World is powered by solitude
VERSION: 3.9.8.5 · 13ms · UTC 21:14 · PVG 05:14 · LAX 14:14 · JFK 17:14
♥ Do have faith in what you're doing.