Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

@deprecated tag MUST be explained #131

Copy link
Copy link
Closed
@lenaorobei

Description

@lenaorobei
Issue body actions

Description

If classes/interfaces/functions/constants/class members are marked as @deprecated the description and @see tag must be provided.

Motivation behind the added @deprecated tag MUST be explained. @see tag MUST be used with reference to new implementation when code is deprecated and there is a new alternative.

Expected behavior

In PHPDoc blocs @deprecated tag must have description and following @see tag with reference.

Good example:

    /**
     * @var string
     * @deprecated 100.2.0 Useful description here.
     * @see /NameSpace/To/Implementation
     */
    protected $classMemberName;

Bad example:

    /**
     * @var string
     * @deprecated
     */
    protected $classMemberName;
ihor-sviziev and fooman

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementImprovements to existing rulesImprovements to existing rules

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.