GitHub PR https://github.com/pfrenssen/coder/pull/237
We have now https://www.drupal.org/project/coder/issues/3400560. That's cool. In my projects, which are using Drupal coding standards, I want to enforce this because constructor comments are only adding noise.
Allow such a setting to work and prohibit commenting the constructor:
<rule ref="Drupal.Commenting.FunctionComment">
<properties>
<property name="commentProhibitedFunctions" type="array">
<element value="__construct"/>
</property>
</properties>
</rule>
None.
None.
None.
None.
Comments
Comment #2
claudiu.cristeaLet's try it
Comment #3
claudiu.cristeaI've added the fix and also tests. However, tests are failing and, even I spent few hours, I can get it. Maybe someone with experience can find the problem.
Comment #4
claudiu.cristeaComment #5
klausiHm, I'm not sure we should do this.
Comments in general are a good thing - they explain what code does. Maybe you want to summarize why you have that constructor and what it is doing?
I think you never want to forbid comments, they should always be allowed on any function.
Sure, constructors are often obvious, so we allow you to omit the function comment. But forbidding it? I think no.
Comment #6
claudiu.cristeaIt’s not specifically about constructors. It could be any method and it’s optional. Nobody is forcing you to use it.
Comment #7
klausiRight, we can add this in a way to leave it disabled. Then add a documentation section somewhere how people can enable it. On drupal.org or in the README file?
I think the pull request should be good once you remove the special constructor handling?
We also need a new test case to demonstrate that this addition works.