为什么开发人员都不愿意写接口文档?

2021-07-21 18:34:54 +08:00
 jessezhang1986
10697 次点击
所在节点    程序员
97 条回复
Felldeadbird
2021-07-22 09:22:12 +08:00
任务堆积,文档重视程度低。 决策层决定开发质量。
cedoo22
2021-07-22 09:26:01 +08:00
@AoEiuV020 如果新来一个前端程序员, 也要用原来的接口,但是参数值会有点调整,这时候是直接看代码嘛???
cedoo22
2021-07-22 09:27:23 +08:00
@NCE 我反而觉得文档有时候和代码一样重要,如果是对外的接口更不用说
AoEiuV020
2021-07-22 09:29:44 +08:00
@cedoo22 一般来说是的,写代码的员工还在的话可能会问一下,不在就只能检查代码了,运气好可能有点注释,
AoEiuV020
2021-07-22 09:31:32 +08:00
@cedoo22 重要归重要,但那是对别人重要,不是对自己,又没有这方面业绩指标要求,舍己为人还是有点难的,
aicfe
2021-07-22 09:32:29 +08:00
公司用 yApi,所以用 idea 搭配 easyYapi 更香,一键导出到 yapi
mosliu
2021-07-22 09:38:26 +08:00
yapi 很好用。
apifox
2021-07-22 09:42:14 +08:00
曾经用过 YApi,连数据结构都没法复用,放弃了
biaomingzhong
2021-07-22 09:50:13 +08:00
我们之前用 YApi,现在改用 Apifox, 基本不存在这个问题了
loryyang
2021-07-22 09:57:57 +08:00
多一事不如少一事,另外,代码变化文档也要跟着变,成本确实太高了
我觉得妥协方案,还是尽量把代码写简单自解释,不要过度设计
wangyzj
2021-07-22 10:10:37 +08:00
把接口二字去掉吧
任何文档都不想写
p1gd0g
2021-07-22 10:14:43 +08:00
都内卷成这样了,老板会在意你写不写文档?
yuankui
2021-07-22 10:18:58 +08:00
我每天要对机器说那么多话(码代码)都那么累了,那还有时间和精力对人说话(写文档)?
SwimmingDragon
2021-07-22 10:22:52 +08:00
前端说,我写的文档还没有我的代码容易看懂。所以我就没有写文档了
intmax2147483647
2021-07-22 10:52:16 +08:00
应该整一个专门写接口文档的岗位
nekoneko
2021-07-22 10:53:45 +08:00
postman 测试完一键生成文档就行了
polyang
2021-07-22 10:57:13 +08:00
开发人员最讨厌的事:
1 、别人不写接口文档;
2 、让我写接口文档。
neptuno
2021-07-22 11:01:43 +08:00
写了很多人也不看呀,,,还是跑过来跟我说你这字段啥意思呀
Bigglesworth
2021-07-22 11:06:24 +08:00
postman 也可以发布文档
yolee599
2021-07-22 11:08:46 +08:00
因为写文档不计入工时

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/790914

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX