Add parameter comment

jxlwqq · jxlwqq · commit 3f0967ff778f · 2018-09-07T11:46:22.000+08:00
diff --git a/src/IdValidator.php b/src/IdValidator.php
@@ -20,7 +20,7 @@ public function __construct()
     /**
      * 验证身份证号合法性.
      *
-     * @param string $id
+     * @param string $id 身份证号
      *
      * @return bool
      */
@@ -66,7 +66,7 @@ public function isValid($id)
     /**
      * 获取身份证信息.
      *
-     * @param $id
+     * @param string $id 身份证号
      *
      * @return array|bool
      */
@@ -92,7 +92,7 @@ public function getInfo($id)
     /**
      * 生成假数据.
      *
-     * @param bool $eighteen
+     * @param bool $eighteen 是否为 18 位
      *
      * @return string
      */
@@ -136,9 +136,9 @@ private function _getPosWeight()
      * 获取数字补位.
      *
      * @param $str
-     * @param int    $len
-     * @param string $chr
-     * @param bool   $right
+     * @param int    $len 长度
+     * @param string $chr 补位值
+     * @param bool   $right 左右
      *
      * @return string
      */
@@ -163,7 +163,7 @@ private function _getStrPad($str, $len = 2, $chr = '0', $right = false)
     /**
      * 获取地址码信息.
      *
-     * @param $addressCode
+     * @param string $addressCode 地址码
      *
      * @return bool|mixed|string
      */
@@ -191,7 +191,7 @@ private function _getAddressInfo($addressCode)
     /**
      * 检查并拆分身份证号.
      *
-     * @param $id
+     * @param string $id 身份证号
      *
      * @return array|bool
      */
@@ -229,7 +229,7 @@ private function _checkIdArgument($id)
     /**
      * 检查地址码
      *
-     * @param $addressCode
+     * @param string $addressCode 地址码
      *
      * @return bool
      */
@@ -243,7 +243,7 @@ private function _checkAddressCode($addressCode)
     /**
      * 检查出生日期码
      *
-     * @param $birthdayCode
+     * @param string $birthdayCode 出生日期码
      *
      * @return bool
      */
@@ -266,7 +266,7 @@ private function _checkBirthdayCode($birthdayCode)
     /**
      * 检查顺序码
      *
-     * @param $orderCode
+     * @param string $orderCode 顺序码
      *
      * @return bool
      */
@@ -282,8 +282,8 @@ private function _checkOrderCode($orderCode)
     /**
      * 生成随机数.
      *
-     * @param $max
-     * @param int $min
+     * @param int $max 最大值
+     * @param int $min 最小值
      *
      * @return int
      */
@@ -296,7 +296,7 @@ private function _generatorRandInt($max, $min = 1)
      * 生成校验码
      * 详细计算方法 @lint https://zh.wikipedia.org/wiki/中华人民共和国公民身份号码
      *
-     * @param $body
+     * @param string $body 身份证号 body 部分
      *
      * @return int|string
      */

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ public function __construct()`
`20`	`20`	`/**`
`21`	`21`	`* 验证身份证号合法性.`
`22`	`22`	`*`
`23`		`- * @param string $id`
	`23`	`+ * @param string $id 身份证号`
`24`	`24`	`*`
`25`	`25`	`* @return bool`
`26`	`26`	`*/`
`@@ -66,7 +66,7 @@ public function isValid($id)`
`66`	`66`	`/**`
`67`	`67`	`* 获取身份证信息.`
`68`	`68`	`*`
`69`		`- * @param $id`
	`69`	`+ * @param string $id 身份证号`
`70`	`70`	`*`
`71`	`71`	`* @return array\|bool`
`72`	`72`	`*/`
`@@ -92,7 +92,7 @@ public function getInfo($id)`
`92`	`92`	`/**`
`93`	`93`	`* 生成假数据.`
`94`	`94`	`*`
`95`		`- * @param bool $eighteen`
	`95`	`+ * @param bool $eighteen 是否为 18 位`
`96`	`96`	`*`
`97`	`97`	`* @return string`
`98`	`98`	`*/`
`@@ -136,9 +136,9 @@ private function _getPosWeight()`
`136`	`136`	`* 获取数字补位.`
`137`	`137`	`*`
`138`	`138`	`* @param $str`
`139`		`- * @param int $len`
`140`		`- * @param string $chr`
`141`		`- * @param bool $right`
	`139`	`+ * @param int $len 长度`
	`140`	`+ * @param string $chr 补位值`
	`141`	`+ * @param bool $right 左右`
`142`	`142`	`*`
`143`	`143`	`* @return string`
`144`	`144`	`*/`
`@@ -163,7 +163,7 @@ private function _getStrPad($str, $len = 2, $chr = '0', $right = false)`
`163`	`163`	`/**`
`164`	`164`	`* 获取地址码信息.`
`165`	`165`	`*`
`166`		`- * @param $addressCode`
	`166`	`+ * @param string $addressCode 地址码`
`167`	`167`	`*`
`168`	`168`	`* @return bool\|mixed\|string`
`169`	`169`	`*/`
`@@ -191,7 +191,7 @@ private function _getAddressInfo($addressCode)`
`191`	`191`	`/**`
`192`	`192`	`* 检查并拆分身份证号.`
`193`	`193`	`*`
`194`		`- * @param $id`
	`194`	`+ * @param string $id 身份证号`
`195`	`195`	`*`
`196`	`196`	`* @return array\|bool`
`197`	`197`	`*/`
`@@ -229,7 +229,7 @@ private function _checkIdArgument($id)`
`229`	`229`	`/**`
`230`	`230`	`* 检查地址码`
`231`	`231`	`*`
`232`		`- * @param $addressCode`
	`232`	`+ * @param string $addressCode 地址码`
`233`	`233`	`*`
`234`	`234`	`* @return bool`
`235`	`235`	`*/`
`@@ -243,7 +243,7 @@ private function _checkAddressCode($addressCode)`
`243`	`243`	`/**`
`244`	`244`	`* 检查出生日期码`
`245`	`245`	`*`
`246`		`- * @param $birthdayCode`
	`246`	`+ * @param string $birthdayCode 出生日期码`
`247`	`247`	`*`
`248`	`248`	`* @return bool`
`249`	`249`	`*/`
`@@ -266,7 +266,7 @@ private function _checkBirthdayCode($birthdayCode)`
`266`	`266`	`/**`
`267`	`267`	`* 检查顺序码`
`268`	`268`	`*`
`269`		`- * @param $orderCode`
	`269`	`+ * @param string $orderCode 顺序码`
`270`	`270`	`*`
`271`	`271`	`* @return bool`
`272`	`272`	`*/`
`@@ -282,8 +282,8 @@ private function _checkOrderCode($orderCode)`
`282`	`282`	`/**`
`283`	`283`	`* 生成随机数.`
`284`	`284`	`*`
`285`		`- * @param $max`
`286`		`- * @param int $min`
	`285`	`+ * @param int $max 最大值`
	`286`	`+ * @param int $min 最小值`
`287`	`287`	`*`
`288`	`288`	`* @return int`
`289`	`289`	`*/`
`@@ -296,7 +296,7 @@ private function _generatorRandInt($max, $min = 1)`
`296`	`296`	`* 生成校验码`
`297`	`297`	`* 详细计算方法 @lint https://zh.wikipedia.org/wiki/中华人民共和国公民身份号码`
`298`	`298`	`*`
`299`		`- * @param $body`
	`299`	`+ * @param string $body 身份证号 body 部分`
`300`	`300`	`*`
`301`	`301`	`* @return int\|string`
`302`	`302`	`*/`