开发规范守则

本文详细介绍了JavaScript代码规范,包括变量命名、函数命名、注释规则等,并强调了遵循规范的重要性。同时,讲解了Git提交信息的格式,如使用`feat`、`fix`等关键字,以提升代码质量和团队协作效率。
摘要由CSDN通过智能技术生成

🛡️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 -删除内容
本文阐述软件项目开发和管理的流程规范,作为软件项目开发的高级指引,本规范定义了软件开发的各个阶段以及每个阶段的工作活动和工件,但不对活动和工件的细节作过多规定。在项目开发过程中,每个项目根据自身的需要确定这些活动和工件的细节。这个阶段的工作目的是决定一个项目是否需要启动。为了达到这个目的,首先要明确项目的总体战略目标,对项目的需要建立认同。即确定到底需要做什么、开发什么产品或提供什么服务,以及需要解决什么样的问题和需要满足客户或市场的什么要求等,同时还要总结项目工作的范围、所需资源、大约开支、各种风险,以及该项目不执行的其他替代选择等。这些代表了对整个项目目标从战略角度和宏观层次所进行的分析,通过项目的意向书总结出来,由此确证客户或项目发起人和赞助者的要求与期望,并帮助他们判定项目是否上马。项目意向总结书的通过及项目被批准上马形成了这个项目的起始点。 前一篇文章《软件开发基本原则》谈论了软件开发原则方面的问题,而本篇文章尝试谈谈软件开发中更具体的一些内容 —— 普通软件项目的开发过程规范。本座也知道,如果过程规范讲的太具体对谈论者来说是非常冒险的一件事情,它不像技术,对就对错就错,有一个客观的评判标准,别人想喷你也得自己先好好研究等拿到了足够的论据才能喷,但开发过程和项目管理就不同了,别人仅凭一点点所谓的管理经验甚至是主观推断就能喷得你体无完肤,摇摇欲坠 ~ 因为没有什么所谓的事实标准与放之四海皆有效的软件开发过程和项目管理方法。保守估计,100个人中至少有150种想法。本座也深知其中的凶险,因此避重就轻,从基本原理谈起,宏观的角度阐述相关问题,尽量减少中弹的机会。欢迎大家畅所欲言 ^_*
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值