JavaScript企业级编程规范(1)-文件命名-注释规范-id与class

前言

好的代码是有生命力的,程序是写给人读的,顺便在机器上跑一下

当你在阅读别人的代码时,据说评判一个项目的好坏,就是看阅读代码人说脏话程度

无注释,无文档,命名千奇百怪等等,对于后来者,是极其痛苦的,其实个人觉得一个非常好的产品,一手代码非常重要,既是标准,往往又是参照。

工作中,往往令人尊敬的,就是代码的产出,少bug,写得又好又快,毫无疑问是团队中最受欢迎的,而好的命名,代码规范往往可以看出一个程序员的功力

做一个自我要求高一点的工程师,而不止于完成任务。从代码规范做起,什么是好代码,可读性好,可维护性高.易拓展.少bug,高质量,这些硬技能并非一蹴而就.非一日之功.

人人都喜欢和聪明人一起工作,我们无法要求别人怎么样,但可以要求自己.

无论团队人数多少，代码应该同出一门。

下面这些规范不是硬性规定,但不妨可以作为参照,向大厂看齐,作为标杆。

·  正  ·  文  ·  来  ·  啦  ·

01

文件夹(项目)命名规范

 

• 项目名全部采用小写方式， 以中划线分隔。比如：my-project-name, 例如:,ant-design-pro,ant-design-colors等大厂开源项目,当项目名称有多个字符时,不是说驼峰命名法myProjectName不行,用横杠中划线进行连接,已经是约定俗成的习惯,一定要向大厂的标准看齐

下面以阿里的Ant Design Team团队出品为例

02

子项目录名

当有复数结构时，要采用复数命名法，如有多个单词时,用横杠连接,比如说： scripts, styles, images, data-models
如下所示

值得一提的是:JavaScript文件的存放的文件夹放在Web应⽤目录中的components文件夹或其以业务组件,应用小写标识命名子文件夹

03

JavaScript文件命名

• 所有的JavaScript文件均以.js结尾

• 所有js文件名，当遇到多个单词组成时，采用中划线连接方式，比如说：比如检查commit提交文件， check-commit.js,首字母小写,如下所示

• 当出现版本号时, 需要用字母v做为前缀, 小版本号用点号(.)隔开, gl