method annotation format update

Author: inhere

README.md

@@ -222,7 +222,7 @@ class HomeController extends Controller
   ![group-command-list](docs/screenshots/group-command-list.png)
 - 当使用 `php examples/app home:test -h` 时，可以查看到关于 `HomeController::testCommand` 更详细的信息。包括描述注释文本、`@usage` 、`@example`
 
-  ![group-command-list](docs/screenshots/group-command-help.png)
+  ![group-command-list](docs/screenshots/command-help.png)
 
 > 小提示：注释里面同样支持带颜色的文本输出 `eg: this is a command's description <info>message</info>`
 

docs/screenshots/command-help.png

@@ -422,12 +422,15 @@ protected function showHelpByMethodAnnotations($method, $action = null, array $a
                 continue;
             }
 
-            $msg = trim($tags[$tag]);
+            // $msg = trim($tags[$tag]);
+            $msg = $tags[$tag];
             $tag = ucfirst($tag);
 
             // for alone command
             if (!$msg && $tag === 'description' && $isAlone) {
                 $msg = self::getDescription();
+            } else {
+                $msg = preg_replace('#(\n)#', '$1 ', $msg);
             }
 
             $help[$tag . ':'] = $msg;

docs/screenshots/group-command-help.png

@@ -20,14 +20,15 @@ final class Annotation
 
     /**
      * Parses the comment block into tags.
-     *
      * @param string $comment The comment block text
+     * @param array $ignored
      * @return array The parsed tags
      */
-    public static function getTags($comment)
+    public static function getTags($comment, array $ignored = ['param', 'return']): array
     {
+        $comment = str_replace("\r\n", "\n", trim($comment, "/ \n"));
         $comment = "@description \n" . str_replace("\r", '',
-                trim(preg_replace('/^\s*\**( |\t)?/m', '', trim($comment, '/')))
+                trim(preg_replace('/^\s*\**( |\t)?/m', '', $comment))
             );
 
         $tags = [];
@@ -36,6 +37,10 @@ public static function getTags($comment)
         foreach ($parts as $part) {
             if (preg_match('/^(\w+)(.*)/ms', trim($part), $matches)) {
                 $name = $matches[1];
+                if (\in_array($name, $ignored, true)) {
+                    continue;
+                }
+
                 if (!isset($tags[$name])) {
                     $tags[$name] = trim($matches[2]);
                 } elseif (\is_array($tags[$name])) {

src/Base/AbstractCommand.php

@@ -286,7 +286,7 @@ public static function howLongAgo($secs)
      * @param $width
      * @return array
      */
-    public static function splitStringByWidth($string, $width)
+    public static function splitStringByWidth($string, $width): array
     {
         // str_split is not suitable for multi-byte characters, we should use preg_split to get char array properly.
         // additionally, array_slice() is not enough as some character has doubled width.
@@ -327,7 +327,7 @@ public static function splitStringByWidth($string, $width)
      * @param  array $opts
      * @return string
      */
-    public static function spliceKeyValue(array $data, array $opts = [])
+    public static function spliceKeyValue(array $data, array $opts = []): string
     {
         $text = '';
         $opts = array_merge([