calendarplus icon indicating copy to clipboard operation
calendarplus copied to clipboard

Consequently use PHPDoc

Open LukasReschke opened this issue 10 years ago • 0 comments

    private $userId;
    private $l10n;
    private $configInfo;
    public function __construct($appName, IRequest $request, $userId, $l10n, IConfig $settings) {
        parent::__construct($appName, $request);
        $this -> userId = $userId;
        $this->l10n = $l10n;
        $this->configInfo = $settings;
    }

vs.

    /** @var string */
    private $userId;
    /** @var IL10N */
    private $l10n;
    /** @var IConfig */
    private $configInfo;

    /**
     * @param string $appName
     * @param IRequest $request
     * @param string $userId
     * @param IL10N $l10n
     * @param IConfig $settings
     */
    public function __construct($appName, 
                                IRequest $request, 
                                $userId, 
                                IL10N $l10n, 
                                IConfig $settings) {
        parent::__construct($appName, $request);
        $this -> userId = $userId;
        $this->l10n = $l10n;
        $this->configInfo = $settings;
    }

Latter one allows better static analysis such as for ScrutinizerCI or a proper IDE.

--- Want to back this issue? **[Post a bounty on it!](https://www.bountysource.com/issues/24506019-consequently-use-phpdoc?utm_campaign=plugin&utm_content=tracker%2F19394737&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://www.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F19394737&utm_medium=issues&utm_source=github).

LukasReschke avatar Jul 17 '15 15:07 LukasReschke