注释规范

library/think/model/Relation.php

@@ -125,9 +125,9 @@ class Relation
     /**
      * 预载入关联查询 返回数据集
      * @access public
-     * @param array $resultSet 数据集
-     * @param string $relation 关联名
-     * @param string $class 数据集对象名 为空表示数组
+     * @param array     $resultSet 数据集
+     * @param string    $relation 关联名
+     * @param string    $class 数据集对象名 为空表示数组
      * @return array
      */
     public function eagerlyResultSet($resultSet, $relation, $class = '')
@@ -221,8 +221,8 @@ class Relation
     /**
      * 封装关联数据集
      * @access public
-     * @param array $resultSet 数据集
-     * @param string $class 数据集类名
+     * @param array     $resultSet 数据集
+     * @param string    $class 数据集类名
      * @return mixed
      */
     protected function resultSetBuild($resultSet, $class = '')
@@ -233,10 +233,10 @@ class Relation
     /**
      * 预载入关联查询 返回模型对象
      * @access public
-     * @param Model $result 数据对象
-     * @param string $relation 关联名
-     * @param string $class 数据集对象名 为空表示数组
-     * @return \think\Model
+     * @param Model     $result 数据对象
+     * @param string    $relation 关联名
+     * @param string    $class 数据集对象名 为空表示数组
+     * @return Model
      */
     public function eagerlyResult($result, $relation, $class = '')
     {
@@ -295,9 +295,9 @@ class Relation
     /**
      * 一对一 关联模型预查询拼装
      * @access public
-     * @param string $model 模型名称
-     * @param string $relation 关联名
-     * @param Model $result 模型对象实例
+     * @param string    $model 模型名称
+     * @param string    $relation 关联名
+     * @param Model     $result 模型对象实例
      * @return void
      */
     protected function match($model, $relation, &$result)
@@ -324,11 +324,11 @@ class Relation
     /**
      * 一对多 关联模型预查询
      * @access public
-     * @param object $model 关联模型对象
-     * @param array $where 关联预查询条件
-     * @param string $relation 关联名
-     * @param string $subRelation 子关联
-     * @param bool $closure
+     * @param object    $model 关联模型对象
+     * @param array     $where 关联预查询条件
+     * @param string    $relation 关联名
+     * @param string    $subRelation 子关联
+     * @param bool      $closure
      * @return array
      */
     protected function eagerlyOneToMany($model, $where, $relation, $subRelation = '', $closure = false)
@@ -348,10 +348,10 @@ class Relation
     /**
      * 多对多 关联模型预查询
      * @access public
-     * @param object $model 关联模型对象
-     * @param array $where 关联预查询条件
-     * @param string $relation 关联名
-     * @param string $subRelation 子关联
+     * @param object    $model 关联模型对象
+     * @param array     $where 关联预查询条件
+     * @param string    $relation 关联名
+     * @param string    $subRelation 子关联
      * @return array
      */
     protected function eagerlyManyToMany($model, $where, $relation, $subRelation = '')
@@ -514,11 +514,11 @@ class Relation
     /**
      * BELONGS TO MANY 关联查询
      * @access public
-     * @param object $model 关联模型对象
-     * @param string $table 中间表名
-     * @param string $foreignKey 关联模型关联键
-     * @param string $localKey 当前模型关联键
-     * @param array $condition 关联查询条件
+     * @param object    $model 关联模型对象
+     * @param string    $table 中间表名
+     * @param string    $foreignKey 关联模型关联键
+     * @param string    $localKey 当前模型关联键
+     * @param array     $condition 关联查询条件
      * @return \think\db\Query|string
      */
     protected function belongsToManyQuery($model, $table, $foreignKey, $localKey, $condition = [])
@@ -535,8 +535,8 @@ class Relation
     /**
      * 保存（新增）当前关联数据对象
      * @access public
-     * @param mixed $data 数据 可以使用数组 关联模型对象 和 关联对象的主键
-     * @param array $pivot 中间表额外数据
+     * @param mixed     $data 数据 可以使用数组 关联模型对象 和 关联对象的主键
+     * @param array     $pivot 中间表额外数据
      * @return integer
      */
     public function save($data, array $pivot = [])
@@ -562,8 +562,8 @@ class Relation
     /**
      * 批量保存当前关联数据对象
      * @access public
-     * @param array $dataSet 数据集
-     * @param array $pivot 中间表额外数据
+     * @param array     $dataSet 数据集
+     * @param array     $pivot 中间表额外数据
      * @return integer
      */
     public function saveAll(array $dataSet, array $pivot = [])
@@ -588,8 +588,8 @@ class Relation
     /**
      * 附加关联的一个中间表数据
      * @access public
-     * @param mixed $data 数据 可以使用数组、关联模型对象 或者 关联对象的主键
-     * @param array $pivot 中间表额外数据
+     * @param mixed     $data 数据 可以使用数组、关联模型对象 或者 关联对象的主键
+     * @param array     $pivot 中间表额外数据
      * @return integer
      */
     public function attach($data, $pivot = [])
@@ -622,8 +622,8 @@ class Relation
     /**
      * 解除关联的一个中间表数据
      * @access public
-     * @param integer|array $data 数据 可以使用关联对象的主键
-     * @param bool $relationDel 是否同时删除关联表数据
+     * @param integer|array     $data 数据 可以使用关联对象的主键
+     * @param bool              $relationDel 是否同时删除关联表数据
      * @return integer
      */
     public function detach($data, $relationDel = false)