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

2021-07-21 18:34:54 +08:00
 jessezhang1986
10290 次点击
所在节点    程序员
97 条回复
66450146
2021-07-21 21:42:59 +08:00
把接口调得能通过机器检查容易

想清楚系统的结构和逻辑并清晰地表达出来很难

写文档就是后者
JerryCha
2021-07-21 22:04:31 +08:00
应付需求已经很累了,还写文档那是连午睡都搭进去了
knightdf
2021-07-21 22:08:58 +08:00
可能上级定任务时间的时候压根就没考虑你写文档的时间
tianxia
2021-07-21 22:27:04 +08:00
因为自己觉得还有变动
echo1937
2021-07-21 23:30:51 +08:00
老板没给这个时间
foxtalk
2021-07-21 23:50:46 +08:00
大公司应该好一点,小公司的领导们,大多不注重代码规范,接口设计,只是抱着能用就行的思维,没有留出足够的时间让你好好设计接口和文档,在他们眼里,项目的进度重要程度是远远大于代码质量和设计文档的。大公司里面有代码审核人员,会好很多。
Euthpic
2021-07-22 00:15:57 +08:00
@apifox 考虑下 yapi
kingfalse
2021-07-22 00:21:48 +08:00
因为写文档不算工作量
sytnishizuiai
2021-07-22 00:45:59 +08:00
前后分离,不写文档,前端怎么开发啊?哪知道传什么,返回什么。

不过文档确实累心,开发的时候忙的要死,还要写文档,开发完了又是一堆事,我是没办法,前后端都在家办公,全靠文档开发。

还有一部分原因在于领导,很多人认为代码跑起来就项目结束,再搞一个。剩下的代码优化,文档写完整,sql 优化也懒的搞了,没精力。
so1n
2021-07-22 00:56:00 +08:00
写文档很累。。。所以我就自己写了一个框架来自动生成文档 https://github.com/so1n/pait
icy37785
2021-07-22 03:06:35 +08:00
自己的项目最烦写文档,别人的项目最烦没文档。
可能这就是社会主义初级阶段的主要矛盾把。
wolong
2021-07-22 06:51:03 +08:00
因为不会写
skys215
2021-07-22 08:36:33 +08:00
因为程序员只会写代码,不会写人话。
Kontinue
2021-07-22 08:46:31 +08:00
新项目和前端对接或者需要第三方对接的时候会写。但是后面需求改动的时候就懒得再改文档了。。。
ada87
2021-07-22 08:46:37 +08:00
标题说了,主要就是因为不愿意。

早上 9 点上班,激情满满的码代码,可以一口激情码到下班。
要是写一小时接口文档,写到 10 点,一整天的心情都不好了,特别是本来就还有干不完的活的情况下(借口),码代码的心情也没了,写代码心情差,效率质量齐下降。
Kontinue
2021-07-22 08:47:41 +08:00
其实都是相对的,和别人对接,不写文档,自然很多细节的地方别人都会来问你,还不如一次性都写清楚
jorneyr
2021-07-22 08:57:09 +08:00
自己不写有合理的理由,但常常抱怨别人不写。
From313
2021-07-22 08:58:24 +08:00
YAPI + 1
niub
2021-07-22 09:07:58 +08:00
写。
andytao
2021-07-22 09:17:14 +08:00
因为代码即文档,代码是最新最完整的文档呀。

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

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

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

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

© 2021 V2EX