聊一聊：你碰到过哪些操蛋的文档？

我们一直强调，要写注释，要写文档！

写出一份好文档是一个开发者应该具备的一项重要能力！

今天在群里（点击加入），看到一个经典的来自某国企的接口文档，引发了一段时间的讨论。

在这个文档中，HTTP接口的内容格式大致是这样的：

请求路径：/api/user

请求参数：

参数	必填	默认值	含义	示例
name	是	无	名称	didi
address	是	无	地址	上海xxx
age	是	无	年龄
gender	是	无	性别
birth	是	无	生日	19900101
graduate	是	无	毕业院校
phone	是	无	电话
native	是	无	籍贯

聪明的你，有发现什么不妥么？

这样的文档群友们打了0分，你觉得可以得几分呢？

留言说说你觉得这样的接口文档问题在哪里呢？

你还碰到过哪些让你想口吐芬芳的文档呢？

往期推荐

聊一聊：Service层你觉得有用吗？

聊一聊：你平时写不写单元测试？

聊一聊：下班后的消息，要不要回？

聊一聊：你都用什么方式回忆青春呢？

聊一聊：MyBatis和Spring Data JPA的选择问题

聊一聊：你碰到过哪些操蛋的文档？相关推荐

打印表格留标题怎么设置_打印如何添加标题？内容一页打不下？—关于Excel文档打印的那些事-excel打印区域怎么设置...
很多情况下,我们制作的Excel电子表格最终是要以纸面形式打印出来的.所以,关于表格打印,你还是要知道以下几个方面,不能让工作卡在最后一关. 一.为Excel文档打印添加标题当Excel表格有多页内 ...
word文档的数据损坏如何进行修复
本文章介绍的Office文档的数据恢复的原理和程序设计方法,都来源于对Office文档结构的分析.如果对Office文档的结构进行更深入的研究,将会发现更好的修复方法, 从而挽救更多的数据,并有可能开 ...
怎样才能写好项目文档？
今天我们来聊一聊,为什么你不爱写项目文档?以及怎样才能写好项目文档? 我以前看过一个投票,盘点程序员不喜欢的事,有两条和文档相关: 不喜欢写文档: 不喜欢项目文档太少. 看起来很矛盾,却很现实.基本上 ...
文档乱码或文档损坏的修复方法
本文章介绍的Office文档的数据恢复的原理和程序设计方法,都来源于对Office文档结构的分析.如果对Office文档的结构进行更深入的研究,将会发现更好的修复方法, 从而挽救更多的数据,并有可能开 ...
企业为什么需要文档管理
企业为什么需要文档管理文档是企业重要的智力资产.在企业中,文档一般都以电子文档的形式存在,比如微软.doc格式,xls格式,ppt格式,pdf格式,纯文本.txt格式等:从内容上,可能是商务合同.会 ...
你不知道的 CSS 文档流技巧，让布局更简单
看文章之前,先来看两个例子.这是我们在项目中最常见的项目布局方式. 案例一:多个容器按照相同间距水平排列. 案例二:常见的菜单导航看到这两个案例时,你可以先短暂的想想平时都是如何实现的,很多同学的答 ...
java学习输出文档
知识地图一.类设计 1.面向对象的设计思想的理解面向对象vs面向过程(洗衣服) 封装: 就是把内部的东西保护起来,不被外界所看到. 继承: 就是用于类的扩展多态: 概念:同一操作作用 ...
method=post 怎么让查看源代码看不到_网站文档不能复制怎么办？教你3个小妙招，1分钟轻松化解...
不知道大家平常在查找资料时,碰到网页资料不能下载时,是怎么样进行处理的.那么笔者今天就来分享我查找不能复制文档时,所用的3个小妙招,帮助轻松化解,一起来看看吧. 1.保存网页当我们遇到一个不能直接复 ...
wps文档复制粘贴序号_10个文档处理神技能，学会让你少走很多弯路!
作者 | 职场叨叨君来源 | 办公资源(pptziyuan) Hello大家好,我是叨叨君~ 前段时间给大家更新了很多关于PPT技巧的内容,Word技术不溜的小伙伴跟我抱怨了:叨叨君你要雨露均沾,不 ...

聊一聊：你碰到过哪些操蛋的文档？

聊一聊：你碰到过哪些操蛋的文档？相关推荐

最新文章

热门文章