前人栽树后人乘凉，给本身的代码来点规范-但愿对你们有用

时间 2019-12-01

标签前人栽树后人乘凉本身代码规范但愿你们有用栏目快乐工作繁體版

原文原文链接

好的规范就像人穿的衣服，一个再好看的美女，衣着邋遢不合体，整我的的气质也会大大下降。php

做者/万能的阿香
本文原发时间：2019-07-14
本文大概阅读时间2分钟
git

速查目录

1、本文的写做缘由
2、版本控制规范
3、代码注释规范
4、PhpStorm经常使用小技巧

1、本文的写做缘由

来新公司快2周啦，负责的项目是用tp3.0写的，熟悉的过程真的是太痛苦了，没文档、注释少、无版本提交记录等等(相信你们都碰到过，这里就不展开了，哈哈你们都懂的 QAQ )npm

公司暂时这方面没有太规范性的东西，为了让之后接手的小伙伴少痛苦点，决定整点规范性的东西给本身用，服务本身、服务他人，同时也能慢慢的提高一下本身（如下内容部分整理自网络）api

好了下面开始进入正题啦^_^网络

2、版本控制规范

先来打个样，咱们平常提交版本信息的时候能够像下面这样写commit(svn|git) :

feat(人员新增): 增长人员批量导入

- 增长批量报盘功能
- 增长人员报盘后结果查询功能
- 修改人员新增布局
复制代码

乍一看可能仍是不清楚提交格式到底什么样子，那么咱们接着看svn

具体的格式内容(用git的同窗能够看这个commitizen)

<type>(<scope>):这里是个空格<subject>
<BLANK LINE>这是空行不用写内容
<body>
<BLANK LINE> 这也是空行不用写内容
<footer>
复制代码

上面提到的格式字段说明

- type 表示提交类别，具体内容以下(能够根据项目具体定义):
    * feat: 添加新特性
    * fix: 修复bug
    * docs: 仅仅修改了文档
    * style: 仅仅修改了空格、格式缩进、都好等等，不改变代码逻辑
    * refactor: 代码重构，没有加新功能或者修复bug
    * perf: 优化相关，好比提高性能、体验
    * test: 增长测试用例
    * chore: 改变构建流程、或者增长依赖库、工具等
    * revert: 回滚到上一个版本
- scope 表示修改范围,非必填（建议填写）
- subject 标题
- body 提交内容主体的具体描述内容
复制代码

3、代码注释规范

本身开发使用的是PhpStorm ，注释主要是基于PhpStorm的Live Templates模板快速生成的(模板变量速查表地址)函数

先上图，看看具体效果,这样看起来是否是很清爽呢

下面是注释中比较经常使用的注释名，根据本身须要具体选择

/** * @name 名字 * @abstract 申明变量/类/方法 * @access 指明这个变量、类、函数/方法的存取权限 * @author 函数做者的名字和邮箱地址 * @category 组织packages * @copyright 指明版权信息 * @const 指明常量 * @deprecate 指明不推荐或者是废弃的信息 * @example 示例 * @exclude 指明当前的注释将不进行分析，不出如今文挡中 * @final 指明这是一个最终的类、方法、属性，禁止派生、修改。 * @global 指明在此函数中引用的全局变量 * @include 指明包含的文件的信息 * @link 定义在线链接 * @module 定义归属的模块信息 * @modulegroup 定义归属的模块组 * @package 定义归属的包的信息 * @param 定义函数或者方法的参数信息 * @return 定义函数或者方法的返回信息 * @see 定义须要参考的函数、变量，并加入相应的超级链接。 * @since 指明该api函数或者方法是从哪一个版本开始引入的 * @static 指明变量、类、函数是静态的。 * @throws 指明此函数可能抛出的错误异常,极其发生的状况 * @todo 指明应该改进或没有实现的地方 * @var 定义说明变量/属性。 * @version 定义版本信息 */

复制代码

4、PhpStorm提高技巧

美之因此如此重要，皆因爱漂亮之心人皆有之。不管对于人，仍是对于文，都如此。工具

附上快速生成注释的配置方式，还没配置的小伙伴赶忙试试吧，是否是很贴心，记得打开大图查看哦

(注：代码都是用IDE快速生成的哦，相信你们都是很“懒”的，才不会用手敲这么多呢，多累啊哈哈)

---------------------------------------------华丽的分割线-----------------------------------------------布局

老夫燎发少年狂
不当心,选错行
误入IT，两眼泪茫茫
post

阿香舒适提示：看完记得休息一下，今天也要元气满满哦有问题欢迎随时交流 THE END ^_^