Closed DuanPengfei closed 2 years ago
代码注释是不是也适当加点 😅
目前几个业界推出的规范中,其中关于文件命名的有:
建议约束如下:
注意:业务仓库下的config文件夹下的文件是特殊文件,有专属的文件格式说明。
目前config文件夹,只会出现在test目录下。
artus lib不会有,还是遵循:全部小写,分割,首字母不可以是
我觉得多单词用驼峰或者 -
隔离,_
有点非主流
我觉得多单词用驼峰或者
-
隔离,_
有点非主流
驼峰肯定不建议。目前看存量很多文件用的是-。可以考虑调整为-,把其他少数驼峰的改下。
驼峰不建议的原因是?
跨平台问题,有些大小写不敏感。
对,这样的话确实得限定小写来规避掉此类问题,分割我投 -
一票
我觉得多单词用驼峰或者
-
隔离,_
有点非主流
Golang/Python/CPP 这一系都惯常使用 _
分割,驼峰一般是 JVM 语言爱用,不过 JavaScript 语境下我也投 -
最新建议:
注意:业务仓库(test)下的config文件夹下的文件是特殊文件,有专属的文件格式约定。
(另外,nginx头部key默认不支持下划线, 极端情况下业务使用文件名作为header,会导致信息丢失)
我投全部小写 +_
一票 ,例如 home_controller.ts
全部单数 + 全部小写 + _
+ 尽量少用那么长的词
投【单数】+【全部小写】+ _
投【单数】+【全部小写】+ _
基于私下讨论和投票结果,结论如下:
1.一律采用小写 2.采用单数形式 3.分隔符采用_
下划线 +1
当前文件、文件夹的命名比较随意,小写加中划线,小驼峰等都存在,单数负数也都存在。需要一个统一规范。
提个建议如下:
a_b_c
d_e_f.ts
controller
constant.ts
而不是controllers
constants.ts