@obstschale Ok, I understand.
But you talked about the Squiz.Commenting.BlockComment sniff, but I think this sniff does not check there is a BlockComment function.

For what I know, this is the Squiz.Commenting.FunctionComment sniff, extending the PEAR.Commenting.FunctionComment one.

These sniffs are checking :

Function has doc comment
/** style is used for function comment
The @return tag
The @param tags
The @throws tags.

And then if you also use the Generic.Commenting.DocComment sniff, it checks the doc comment will start with a short description.

So it seems more difficult to make something coherent, I need more example.

class Foo {

  /**
   * You say it's mandatory, even if there is no need for param/return/throws tag
   */
  public function one() {}

  /**
   * You say it's not mandatory
   */
  protected function two() {}

  /**
   * It is still not mandatory for you even if it needs a param/return tag ?
   */
  private function three(int $foo) { return 1; }
}

Personally, in my project, if the function needs no @param/@return/@throws tag, the phpDoc is not needed (for protected, private but also public function). I can understand someone who want this rule only for protected/private ones, or only private ones.

If the expected rule is "The phpDoc is not needed for protected/private function even if they need @param/@return/@throws tags", it's easy to add an option, but I feel like it's very specific and then maybe it will need more feedback, because I'm not sure @gsherwood will accept an option used by a single person/team/project.

Check doc comment only for public methods. #2077

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions