阅读 1365

前人栽树后人乘凉,给自己的代码来点规范-希望对大家有用

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

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

速查目录

  • 一、本文的写作原因
  • 二、版本控制规范
  • 三、代码注释规范
  • 四、PhpStorm常用小技巧

一、本文的写作原因

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

公司暂时这方面没有太规范性的东西,为了让以后接手的小伙伴少痛苦点,决定整点规范性的东西给自己用,服务自己、服务他人,同时也能慢慢的提升一下自己(以下内容部分整理自网络)

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



二、版本控制规范

先来打个样,我们日常提交版本信息的时候可以像下面这样写commit(svn|git) :

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

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

乍一看可能还是不清楚提交格式到底什么样子,那么我们接着看

具体的格式内容(用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 提交内容主体的具体描述内容
复制代码

三、代码注释规范

自己开发使用的是PhpStorm ,注释主要是基于PhpStormLive 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 定义版本信息
*/

复制代码

四、PhpStorm提升技巧

美之所以如此重要,皆因爱美之心人皆有之。无论对于人,还是对于文,都如此。

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

(:代码都是用IDE快速生成的哦,相信大家都是很“懒”的,才不会用手敲这么多呢,多累啊哈哈)

---------------------------------------------华丽的分割线-----------------------------------------------

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

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

关注下面的标签,发现更多相似文章
评论