开发规范

作者: 四冥 | 来源:发表于2021-09-16 14:15 被阅读0次

🛡️JavaScript代码规范

代码规范通常包括这几个方面

  • 变量和函数的命名规则
  • 空格,缩进,注释的使用规则。
  • 其他常用规范……

写代码应该注意的事情

  1. 变量名声明不一样,不要使用相似或容易重复的变量名。
  2. 代码中的命名必须字母开头,字母结束,不能出现中文
  3. 尽量少使用缩写。
  4. 不要随便新增变量,仅在绝对必要时才添加新变量。

尽量遵循代码规范

  • 遵从其中的一丢丢,你的代码就会变得充满惊喜。
  • 遵从其中的一大部分,你的代码将真正成为你的代码,没有人会想改变它。
  • 遵从所有,你的代码将成为寻求启发的年轻开发者的宝贵案例。

命名

JavaScript命名应遵循 简洁、语义化 的原则。

变量名&常量名

变量 :

  • 变量小驼峰式命名法。
  • 全局变量全部大写 。

常量:使用大写字母和下划线来组合命名,下划线用来分割单词。

let lastName; //变量
let COLOR; //全局变量
const CONSTANT; //常量大写

函数&方法命名

函数&方法 :

  • 使用小驼峰式命名法。
  • 前缀应该为动词。
  • 建议常用动词要约定好。
function getData() {} //获取数据
代码 输出
can 判断是否可执行某个动作
has 判断是否含义某个值
is 判断是否为某个值
get 获取某个值
set 设置某个值
load 加载某些数据

语句规则

简单语句的通用规则:

  • 一条语句通常以分号作为结束符。
  • 将左花括号放在第一行的结尾。
  • 左花括号前添加一空格。
  • 将右花括号独立放在一行。
  • 不要以分号结束一个复杂的声明。

🛡️git

Commit message

首先我们要了解一点——Commit message 的作用。

  • 目的很简单就是为了提供更多的历史信息,方便快速浏览。
  • 可以过滤某些commit(比如文档改动),便于快速查找信息。
  • 为 Code Reviewing做准备。
  • 提高项目的整体质量,提高个人工程素质。
  • ......

提交commit 的时候,应注意一下准则。

  • feat - 新增功能
  • fix - 修改内容
  • fix - 修改内容
  • close - 关闭 issue
  • clean -删除内容

相关文章

  • 移动前端开发规范(一般规范)

    系列目录 移动前端开发规范(一般规范)移动前端开发规范(技术栈规范)移动前端开发规范(HTML规范)移动前端开发规...

  • 开发规范

    开发规范分为以下几种1.后台开发规范2.界面布局规范3.模块命名规范4.数据库开发规范 2.界面布局规范 软件窗口...

  • MySQL运维及开发规范

    MySQL运维及开发规范 一.基础规范 二.命名规范 库、表、字段开发设计规范 四.索引规范 五.SQL规范 六....

  • 开发规范 | iOS开发规范

    1. 关于命名 1> 统一要求 含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释 使用全称,不适用缩...

  • iOS开发规范

    iOS开发规范 目录 编写目的 制定开发规范,可以在团队内部形成统一的开发习惯,减少协作的理解成本。此开发规范主要...

  • 2018-09-19 开发规范的重要性

    为什么要规范开发规范

  • Android组开发规范-参考95%参考阿里

    Android组开发规范 本文参考借鉴阿里Android规范 一、目标 Android组开发规范用以指导团队成员,...

  • Android开发规范

    Android开发规范有助于提高开发效率,整理,搜集开发规范后,如下 比较全面具体的规范来自:原创文章,转载请注明...

  • 《javascript基础补充--开发规范》

    JavaScript 开发规范 本篇文章主要介绍了JS的命名规范、注释规范以及开发的一些问题 目录 命名规范:介绍...

  • VueJs前端开发规范

    ## VUEJS开发规范 ## 1. 基于组件化开发理解 2. 组件命名规范 3. 结构化规范 4. 注释规范 5...

网友评论

    本文标题:开发规范

    本文链接:https://www.haomeiwen.com/subject/lomrgltx.html