Why is the use of @uses tag inDocBlocks discouraged?

Viewing 3 replies - 1 through 3 (of 3 total)
  • Moderator Samuel Wood (Otto)

    (@otto42)

    www.ads-software.com Admin

    Because the uses tag isn’t particularly useful, and people tended to use it wrongly in the past. The uses and used-by information can be derived through other means such as parsing the code. It doesn’t add anything to explicitly document these details.

    Thread Starter Stiofan

    (@stiofansisland)

    Thanks for the answer, my plugin would not have required a PHP parser if the @uses tag was being used but i have not decided to parse the code to link them that way. The way the @uses tag is described for use does fit exactly though what it was used for in WP in the past.

    Moderator Samuel Wood (Otto)

    (@otto42)

    www.ads-software.com Admin

    Not necessarily a PHP Parser, as such, just that code syntax is well understood by most IDEs already. Things like function calls and such are already parsed and understood. You don’t need to explicitly add them with @uses for IDEs to get and auto-link you to them, to documentation on them, etc.

Viewing 3 replies - 1 through 3 (of 3 total)
  • The topic ‘Why is the use of @uses tag inDocBlocks discouraged?’ is closed to new replies.

Tags