代码命名规范

1. 项目名

  • 全部采用小写方式, 以短横线分隔。例:my-project-name。

2. 目录名

  • 参照项目命名规则,有复数结构时,要采用复数命名法。例:docs、assets、components、directives、mixins、utils、views。

3. HTML

  • 标签不要大写,即便是 doctype 标签。
  • 用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法。
  • 嵌套元素应当缩进一次(即两个空格)。
  • 对于属性的定义,永远全部使用双引号,绝不要使用单引号。
  • 不要在自闭合(self-closing)元素的尾部添加斜线 — HTML5 规范 中明确说明斜线是可忽略的。
  • 不要省略可选的结束标签(closing tag)(例如,</li> 或 </body>)。

4. class 命名

  • class 名称中只能出现小写字符和破折号(dashe)(不是下划线,也不是驼峰命名法)。破折号应当用于相关 class 的命名(类似于命名空间)(例如,.btn 和 .btn-danger)。
  • 避免过度任意的简写。.btn 代表 button,但是 .s 不能表达任何意思。
  • class 名称应当尽可能短,并且意义明确。
  • 使用有意义的名称。使用有组织的或目的明确的名称,不要使用表现形式(presentational)的名称。
  • 基于最近的父 class 或基本(base) class 作为新 class 的前缀。
  • 使用 .js-* class 来标识行为(与样式相对),并且不要将这些 class 包含到 CSS 文件中。
     在为 Sass 和 Less 变量命名时也可以参考上面列出的各项规范。

5.  js变量

  • 变量名区分大小写(y 和 Y 是不同的变量)
  • 变量名包含字母、数字、美元符号($)和下划线,但第一个字符不允许是数字,不允许包含空格和其他标点符号;变量也能以 $ 和 _ 符号开头(不过不推荐这么做)
  • 当变量名是由两个或多个单词构成时,可以采用驼峰命名法。(大多数都用小驼峰)
  • 驼峰命名有两种形式:
  • 小驼峰式命名法(lower camel case):第一个单字以小写字母开始;第二个单字的首字母大写,例如:firstName、lastName (推荐这种) 。
  • 大驼峰式命名法(upper camel case):每一个单字的首字母都采用大写字母,例如:FirstName、LastName、CamelCase,也被称为Pascal命名法。
  • 帕斯卡命名法 即变量名由两个或多个单词构成时,单词之间用连接号(-)、下划线(_)连接。如first-name或者说first_name(大多时候用下划线)。
  • const用于声明常量,一旦定义就不能修改,常量声明后需同时赋值,并且常量通常以大写字母命名。

6. 函数命名

  • 统一使用动词或者动词+名词形式 ---- fnInit()
  • 如果有内部函数则“_”开头  _fnInit().
  • 对象方法命名使用fn+对象类名+动词+名词形式  fnAnimateDoRun()
  • 某事件响应函数命名方式为fn+触发事件对象名+事件名或者模块名  fnDivClick()

7. 类 & 构造函数

  • 命名方法:大写驼峰式命名法,首字母大写。
posted @ 2022-06-13 15:46  温柔的小猫  阅读(551)  评论(0编辑  收藏  举报