聊一聊：你碰到過哪些操蛋的文檔？

我們一直強調，要寫註釋，要寫文檔！

寫出一份好文檔是一個開發者應該具備的一項重要能力！

今天在羣裏（點擊加入），看到一個經典的來自某國企的接口文檔，引發了一段時間的討論。

在這個文檔中，HTTP接口的內容格式大致是這樣的：

---

請求路徑：/api/user

請求參數：

參數	必填	默認值	含義	示例
name	是	無	名稱	didi
address	是	無	地址	上海xxx
age	是	無	年齡
gender	是	無	性別
birth	是	無	生日	19900101
graduate	是	無	畢業院校
phone	是	無	電話
native	是	無	籍貫

---

聰明的你，有發現什麼不妥麼？

這樣的文檔羣友們打了0分，你覺得可以得幾分呢？

留言說說你覺得這樣的接口文檔問題在哪裏呢？

你還碰到過哪些讓你想口吐芬芳的文檔呢？

往期推薦

聊一聊：Service層你覺得有用嗎？

聊一聊：你平時寫不寫單元測試？

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

聊一聊：你都用什麼方式回憶青春呢？

聊一聊：MyBatis和Spring Data JPA的選擇問題

本文分享自微信公衆號 - 程序猿DD（didispace）。
如有侵權，請聯繫 [email protected] 刪除。
本文參與“OSC源創計劃”，歡迎正在閱讀的你也加入，一起分享。