PHP编码规范 - 自用笔记

注释规范非常影响自身和别人的编程体验，不管别人怎样吧，自己写的遵守以下规范：

1、文件注释

a.注释开始 /* 不可以 /**，结束 */ 不可以 **/。
b.第二行php版本信息，版本信息后一空行。
c.注解内容对齐，注解之间不可有空行。
d.星号和注释内容中间必须是一个空格。
e.保持注解顺序一致@copyright然后@link再@license。

<?php

/*
 * PHP version 5.5
 *
 * @copyright Copyright (c) 2005-2015 YANTENG Inc. (http://www.xxx.com)
 * @link       http://www.xxx.com
 * @license    xxx公司版权所有
 */

namespace VendorgiPackage; 

class ClassName{
    public function aVeryLongMethodName(ClassTypeHint $arg1,&$arg2,array $arg3 = []){
        // method body    
    }
}

2、类注释