最近接手了一个上古项目，没有任何文档，很多变量名都是一些比较泛的名字，导致维护的时候，理解起来非常困难。再加上项目是 前后端分离，为了修复一个接口，要同时理解两个毫无文档的上古项目。
深切的体会到了什么叫做“好的命名是最好的文档”。
总结了一下这么几条：
- 项目名不应该用代号
- 模块名更应该拒绝使用代号
- 拒绝使用拼音缩写
- 拒绝使用缩写，即便是长命名也比缩写好的多
- 驼峰还是下划线，遵循组内规定即可
- README 应该写项目相关的内容
- 项目文档应该跟着代码走而不是保存在第三方
具体的可以看链接(这么认为的原因我都写链接里了，就不再抄一遍过来了)： https://jiajunhuang.com/articles/2019_07_29-name_is_the_best_doc.md.html
不知道大家是否有类似的感悟，以及经验？
Select Language