好代码是活的，程序是写给人读的。对了，在机器上运行

当你在阅读别人的代码时，据说判断一个项目是读者发誓的程度

没有注释，没有文档，命名奇怪等等，对于后来者来说，极其痛苦，其实我觉得一个非常好的产品，第一手的代码是非常重要的，既有标准，往往也是一个参考

在工作中，通常尊重的是代码的输出，它bug较少，写得又好又快。无疑是团队中最受尊敬的，好的命名往往显示了一个程序员的功力

做一个自我要求的工程师，而不仅仅是完成任务。从代码规范开始，什么是好代码，可读性、可维护性、易扩展性、bug少、质量高，这些硬技能不是一蹴而就的。不是一天的工作。

每个人都喜欢和聪明人一起工作。我们不能问别人我们想要什么，但我们可以问自己。不管有多少个团队，代码都应该是一样的。以下规范并非硬性规定，但不妨作为向大厂看齐的参考~

当有复数结构时，使用复数命名法。如果有多个单词，请使用条来连接它们，例如：脚本、样式、图像、数据模型

参考项目命名规则，当遇到多个单词时，使用中线连接法，例如：

另请参阅项目命名。多个字组成时，采用中线连接法，例如：

另外参考项目命名，当多个单词组成时，使用下划线连接，input_bg_search_default，组件类别功能状态，对应的中文是：输入框背景色搜索默认，这种命名方法并不难，应该灵活，语义丰富，最好是让人看到名字就能理解这张图的意思

以上命名约定适用于html、css、js、png、gif、jpg，

前端维护的所有文件类型和相关目录。

对于文件和目录或者变量的命名，确实很头疼，但是对于程序员来说，却是一个问题，必须有人想办法解决：推荐一个变量命名工件站点[codeIf](，当然你也可以在vcode插件市场上搜索codeIf，直接安装。使用起来也很简单，选择变量word，右键点击codeIf，进入这个变量命名工件站点）

它涉及文档注释、单行注释和多行注释、变量、语句和函数注释

文档注释

当注释为整个文件时，它必须放在js文件的开头。注释顺序和内容如下。这不是硬性规定，它取决于您自己的公司和项目的注释规范

对于这种代码注释配置，很多代码编辑器都有相应的插件和快捷键配置：以vcode为例，在vcode的应用商店中搜索并安装koroFileHeader。具体配置请参考VsCode插件，它自动生成批注koroFileHeader

如果实在不知道怎么做，也可以加我的微信搜索随笔川集，手把手教你。不过对于一个写代码的小伙伴来说，玩插件和配置应该不成问题

单行注释

多行注释

这里建议在以下情况下使用多行注释：

变量语句注释

对于变量中的语句注释，可以使用javaScript标准的单行注释将它们放在变量定义行和语句行上方的行中，如下所示//获取窗口的宽度

在开发中，不改变的常量用大写字母表示，多个单词用下划线连接

函数注释必须放在函数定义上面一行的函数注释，包括：

*id和class的一般命名规则是：内容第一，性能第二。

首先，根据内容命名，如main-nav。如果根据内容找不到合适的名称，可以将其与演示文稿结合使用，如skin-blue和present-tab。

主要介绍javaScript中的8个编程规范，如文件夹项目命名规范、子项目目录名、javaScript文件名、css、less、sass、html、图片资源、注释规范、id和类命名

上面列出的规格不是硬性的。只需遵循自己项目的规范，编写人们能理解的代码

我个人认为最好的学习方式是参考学习能力强的人的代码，你可以在github上读到优秀的开源代码

升级您自己的代码规范，限于篇幅，更多内容请参见下一篇文章