完善注释

top-think · Jul 3, 2018 · b00180c · b00180c
1 parent 6104c15
commit b00180c
Showing 1 changed file with 42 additions and 1 deletion.
diff --git a/src/command/Swoole.php b/src/command/Swoole.php
@@ -34,7 +34,7 @@ public function configure()
     {
         $this->setName('swoole')
             ->addArgument('action', Argument::OPTIONAL, "start|stop|restart|reload", 'start')
-            ->addOption('daemon', 'd', Option::VALUE_NONE, 'daemonize.')
+            ->addOption('daemon', 'd', Option::VALUE_NONE, 'Run the swoole server in daemon mode.')
             ->setDescription('Swoole HTTP Server for ThinkPHP');
     }
 
@@ -51,6 +51,11 @@ public function execute(Input $input, Output $output)
         }
     }
 
+    /**
+     * 启动server
+     * @access protected
+     * @return void
+     */
     protected function start()
     {
         $pid = $this->getMasterPid();
@@ -80,6 +85,11 @@ protected function start()
         $swoole->start();
     }
 
+    /**
+     * 柔性重启server
+     * @access protected
+     * @return void
+     */
     protected function reload()
     {
         // 柔性重启使用管理PID
@@ -95,6 +105,11 @@ protected function reload()
         $this->output->writeln('> success');
     }
 
+    /**
+     * 停止server
+     * @access protected
+     * @return void
+     */
     protected function stop()
     {
         $pid = $this->getMasterPid();
@@ -112,6 +127,11 @@ protected function stop()
         $this->output->writeln('> success');
     }
 
+    /**
+     * 重启server
+     * @access protected
+     * @return void
+     */
     protected function restart()
     {
         $pid = $this->getMasterPid();
@@ -123,6 +143,11 @@ protected function restart()
         $this->start();
     }
 
+    /**
+     * 获取主进程PID
+     * @access protected
+     * @return int
+     */
     protected function getMasterPid()
     {
         $masterPid = Cache::get('swoole_master_pid');
@@ -141,6 +166,11 @@ protected function getMasterPid()
         return $masterPid;
     }
 
+    /**
+     * 获取管理进程PID
+     * @access protected
+     * @return int
+     */
     protected function getManagerPid()
     {
         $managerPid = Cache::get('swoole_manager_pid');
@@ -159,6 +189,11 @@ protected function getManagerPid()
         return $managerPid;
     }
 
+    /**
+     * 删除PID文件
+     * @access protected
+     * @return void
+     */
     protected function removePid()
     {
         $masterPid = $this->config['pid_file'];
@@ -177,6 +212,12 @@ protected function removePid()
         Cache::rm('swoole_manager_pid');
     }
 
+    /**
+     * 判断PID是否在运行
+     * @access protected
+     * @param  int $pid
+     * @return bool
+     */
     protected function isRunning($pid)
     {
         if (empty($pid)) {