@@ -104,7 +104,10 @@ use inhere\console\utils\AnsiCode;
104104class TestCommand extends Command
105105{
106106 /**
107- * {@inheritdoc}
107+ * execute
108+ * @param inhere\console\io\Input $input
109+ * @param inhere\console\io\Output $output
110+ * @return int
108111 */
109112 public function execute($input, $output)
110113 {
@@ -113,6 +116,8 @@ class TestCommand extends Command
113116}
114117```
115118
119+ 注册命令,在 ` $app->run() ` 之前通过 ` $app->command('test', TestCommand::class) ` 注册独立命令。
120+
116121- 通过继承 ` inhere\console\Controller ` 添加一组命令(命令行的控制器类)
117122
118123``` php
@@ -139,7 +144,18 @@ class HomeController extends Controller
139144}
140145```
141146
142- 更多请查看 [ ] ( ./examples ) 中的示例代码
147+ 注册命令,在 ` $app->run() ` 之前通过 ` $app->controller('home', HomeController::class) ` 注册命令组。
148+
149+ 说明:
150+
151+ 命令组(eg ` HomeController ` ) 中的命令(eg: ` indexCommand ` )上注释是可被解析的。
152+
153+ - 当你使用 ` php examples/app home -h ` 时,可以查看到 ` HomeController::indexCommand ` 的描述注释文本
154+ - 当使用 ` php examples/app home/index -h ` 时,可以查看到关于 ` HomeController::indexCommand ` 更详细的信息。包括描述注释文本、` @usage ` 、` @example `
155+
156+ > 小提示:注释里面同样支持带颜色的文本输出 ` eg: this is a command's description <info>message</info> `
157+
158+ 更多请查看 [ examples] ( ./examples ) 中的示例代码
143159
144160## 输入
145161
@@ -151,18 +167,16 @@ class HomeController extends Controller
151167$ php examples/app home/useArg status=2 name=john arg0 -s=test --page=23 --id=154 -e dev -v vvv -d -rf --debug --test=false
152168```
153169
154- 一点说明:
170+ ** 一点说明:**
155171
156172- 没有 ` - ` 开头的都认为是参数 (eg: ` status=2 ` ` arg0 ` )
157- - 反之,以 ` - ` 开头的则是选项数据。
173+ - 反之,以 ` - ` 开头的则是选项数据
158174 - ` -- ` 开头的是长选项(long-option)
159175 - 一个 ` - ` 开头的是短选项(short-option)
160176
161177> 支持混合式选项的赋值 ` --id=154 ` 和 ` --id 154 ` 是等效的
162178
163- ** 注意:**
164-
165- 输入如下的字符串将会认为是布尔值
179+ ** 注意:** 输入如下的字符串将会认为是布尔值
166180
167181- ` on|yes|true ` -- ` true `
168182- ` off|no|false ` -- ` false `
@@ -177,7 +191,7 @@ echo $input->getFullScript(); // 命令行输入的原样字符串
177191
178192### 获取解析后的参数信息
179193
180- > 通常的参数如 ` arg0 ` 只能根据 index key 来获取值。但是提供以等号(` = ` )连接的命名方式来指定/获取参数 (eg: ` status=2 ` )
194+ > 通常的参数如 ` arg0 ` 只能根据 index key 来获取值。但是提供以等号(` = ` )连接的方式来指定参数名 (eg: ` status=2 ` )
181195
182196打印所有的参数信息:
183197
@@ -206,8 +220,8 @@ $status = $input->get('status', 'default value'); // '2'
206220### 获取解析后的选项信息
207221
208222- 没有值的选项,将设置默认值为 ` bool(true) `
209- - 短选项不仅仅只是以一个 ` - ` 开头,而且名称只能是一个字符
210- - 多个(默认值的)短选项可以合并到一起写。如 ` -rf ` 会被解析为两个短选项
223+ - 短选项不仅仅只是以一个 ` - ` 开头,而且名称 ** 只能是一个字符 **
224+ - 多个(默认值的)短选项可以合并到一起写。如 ` -rf ` 会被解析为两个短选项 ` 'r' => bool(true) ` ` 'f' => bool(true) `
211225
212226打印所有的选项信息:
213227
@@ -244,20 +258,23 @@ $test = $input->boolOpt('test') // False
244258
245259$d = $input->boolOpt('d') // True
246260$d = $input->sBoolOpt('d') // True
261+ $showHelp = $input->sameOpt(['h','help']) // 获取到一个值就返回,适合同一个含义的选项
247262```
248263
249264### 读取用户输入
250265
251266``` php
252267echo "Your name:";
253268
254- $text = $input->read();
269+ $name = $input->read();
255270// in terminal
256271// Your name: simon
257272
258- echo $text ; // 'simon'
273+ echo $name ; // 'simon'
259274```
260275
276+ 也可以直接将消息文本放入参数 ` $name = $input->read("Your name:"); `
277+
261278## 输出
262279
263280> 输出对象是 ` inhere\console\io\Output ` 的实例
@@ -333,8 +350,9 @@ Show::aList($data, $title);
333350#### 多列表数据展示输出
334351
335352``` php
336- public static function multiList (array $data, array $opts = [])
353+ public static function mList (array $data, array $opts = [])
337354```
355+
338356使用 ` Show::mList()/$output->mList() ` 别名方法 ` Show::multiList() `
339357
340358``` php
@@ -358,8 +376,8 @@ Show::mList($data);
358376``` php
359377public static function panel(mixed $data, $title = 'Information Panel', $borderChar = '*')
360378```
361- 使用 ` Show::panel()/$output->panel() `
362379
380+ 使用 ` Show::panel()/$output->panel() `
363381
364382#### 数据表格信息输出
365383
@@ -389,7 +407,7 @@ Show::table($data, 'a table');
389407$data = [
390408 [ value1, value2, value3, ... ], // first row
391409 [ value4, value5, value6, ... ], // second row
392- ... ...
410+ // ... ...
393411];
394412
395413$opts = [
0 commit comments