php代码注释最佳实践

    use Yii;

    /**
    * This is the model class for table "posts".
    * Class Posts
    * @see \yii\db\ActiveRecord
    * @author jenson
    * @package app\models
    * @property int $id 文章主键   # new了这个类后，可以将直接调用该属性，一般这类属性由魔术方法处理
    * @property string|null $title 标题
    * @property string|null $content 文章内容
    * @property string|null $created_at 创建时间
    * @property string|null $updated_at 更新时间
    * @method string testMethod($param) 测试方法 # new了这个类后,编辑器可以识别到该方法
    */
    class Posts extends \yii\db\ActiveRecord
    {
        /**
        * {@inheritdoc}  # 继承文档
        * @return string # 返回字符串类型
        */
        public static function tableName()
        {
            return 'posts';
        }

        /**
        * @param string $name  # 参数
        **/
        public function testGetDb($name) {
            /**
            * @var \yii\db\Connection $db  # 申明下面的$db变量的类型，方便后面调用
            */
            $db =  \Yii::$app->get('db');
            $db->getQueryBuilder()->db;
        }
    }