Skip to content

Files

Latest commit

 

History

History
18 lines (10 loc) · 706 Bytes

SlevomatCodingStandard.Commenting.ForbiddenComments.md

File metadata and controls

18 lines (10 loc) · 706 Bytes

Pattern: Forbidden comment

Issue: -

Description

Reports forbidden comments in descriptions. Nothing is forbidden by default, the configuration is completely up to the user. It's recommended to forbid generated or inappropriate messages like:

  • Constructor.
  • Created by PhpStorm.

Rule provides the following settings:

  • forbiddenCommentPatterns: allows to configure which comments are forbidden to be used. This is an array of regular expressions (PCRE) with delimiters.

Further Reading