add description to console command ?

Yii 2.0 General Discussions
1

I create a controller to run in command line follow the the official instruction (http://www.yiiframework.com/doc-2.0/guide-tutorial-console.html#create-command).

When I run ‘yii’, I have a list of console commands to run. The built-in commands have nice short description next to the command. For example

  • migrate Manages application migrations.

    migrate/create Creates a new migration

Here is my command as shown when running ‘yii’

  • console

    console/update-ongoing-cost

Note that there are no descriptions to my custom console commands. How do I add them for clarifications ?

2

Just add standard PHPDoc comments to controller classes, action methods, arguments and options. Yii’s help system will parse and display them automatically.