According to revised coding standards of PSR-4-compliant @file doc block has no use anymore.

The only @file doc blocks to remove would be for files under (modulename)/src -- the PSR-4-compliant class/interface files.

CommentFileSizeAuthor
#2 removing-doccomment-2747109-2.patch4.3 KBharsh.behl
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

pen created an issue. See original summary.

harsh.behl’s picture

harsh.behl CreditAttribution: harsh.behl at TO THE NEW commented
FileSize
removing-doccomment-2747109-2.patch4.3 KB

I have created a patch for removing multiple annotations and @file docblock commenting.

harsh.behl’s picture

harsh.behl CreditAttribution: harsh.behl at TO THE NEW commented
Status: Active » Needs review
anish.a’s picture

anish.a CreditAttribution: anish.a at Zyxware Technologies commented
Status: Needs review » Reviewed & tested by the community

As per as https://www.drupal.org/coding-standards/docs#file (Last paragraph).

files that contain a namespaced class/interface/trait, whose file name is the class name with a .php extension, and whose file path is closely related to the namespace (under PSR-4 or a similar standard), SHOULD NOT have a @file documentation block.

Tested this on 8.x branch and working fine.

  • guschilds committed e5d4d1f on 8.x-1.x authored by pen 
    Issue #2747109 by pen: Removed incorrect @file docblocks.
guschilds’s picture

guschilds CreditAttribution: guschilds at Chromatic commented
Status: Reviewed & tested by the community » Fixed

Thanks. The patch from #2 has been committed.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.