最近接手了一个上古项目，没有任何文档，很多变量名都是一些比较泛的名字，导致维护的时候，理解起来非常困难。再加上项目是 前后端分离，为了修复一个接口，要同时理解两个毫无文档的上古项目。
深切的体会到了什么叫做“好的命名是最好的文档”。
总结了一下这么几条：
具体的可以看链接(这么认为的原因我都写链接里了，就不再抄一遍过来了)： https://jiajunhuang.com/articles/2019_07_29-name_is_the_best_doc.md.html
不知道大家是否有类似的感悟，以及经验？
这是一个专为移动设备优化的页面（即为了让你能够在 Google 搜索结果里秒开这个页面），如果你希望参与 V2EX 社区的讨论，你可以继续到 V2EX 上打开本讨论主题的完整版本。
V2EX 是创意工作者们的社区，是一个分享自己正在做的有趣事物、交流想法，可以遇见新朋友甚至新机会的地方。
V2EX is a community of developers, designers and creative people.