search

magento / magento-coding-standard

Magento Coding Standard
Open Software License 3.0
350 stars 153 forks source link

@author MUST NOT be used. #167

Closed arushibansal013 closed 1 year ago

arushibansal013 commented 4 years ago

Rule

@author MUST NOT be used

Reason

As per magento DocBlock document (https://devdocs.magento.com/guides/v2.3/coding-standards/docblock-standard-general.html#documentation-space)

Structure of documentation space @author ,@category, @package, and @subpackage MUST NOT be used. Documentation is organized with the use of namespaces.

Implementation

Need to add @author in $forbiddenTags

cjnewbs commented 3 years ago

@arushibansal013 I have created a PR (#204) that adds the ability to use phpcbf to remove automatically. Is it worth me adding @author in the same PR?

ihor-sviziev commented 2 years ago

Hi @arushibansal013 @fredden, Could you please explain why shouldn't we allow using the @author tag in the coding standards? As for me - it might be relevant only to Magento / Adobe Commerce core but not relevant for all custom extensions.

fredden commented 2 years ago

It looks like the rule was introduced here: https://github.com/magento/devdocs/commit/4165be844c0f96bdcc41b2f952668579266f1a6e

ihor-sviziev commented 2 years ago

I believe all the mentioned tags must not exist in the Magento core, but it should be allowed for the custom extensions.

Am I right, @Vinai @sivaschenko ?

What I mean - we should move this rule to the following rule set https://github.com/magento/magento-coding-standard/blob/develop/Magento2Framework/ruleset.xml and add what you just suggest editors. Does it make sense?