Implement rule from #107

[udovicic]

In compliance with devdocs, rule will check if all occurrences of define() and const have dock block in front of them.

As #107 suggest, it will emit warning with severity 5.

[magento-cicd2]

All committers have signed the CLA.

[lenaorobei]

@udovicic thank you for the contribution, it will be great improvement! I have few comments:

1. Please use strict comparison.
2. The rule says:

Constants must have short description if they add information beyond what the constant name supplies.

Suggest adding check for comments that do not add additional info.

Should raise the warning:

/**
 * Nesting separator.
 */
const NESTING_SEPARATOR = '->';

/**
 * 
 */
const NUMBER_TWO = 2;

Same for define.

Should not raise the warning:

const NESTING_SEPARATOR = '->';

/**
 * Some great explanation here.
 */
const NUMBER_TWO = 2;

[udovicic]

Hi @lenaorobei ,

Suggestions about strict checks are accepted, let me know if you want them squashed.

About the part:

if they add information beyond what the constant name supplies.

That is not what the cited devdocs say. There it is defined as implemented in this rule:

Constants must have short description.

[lenaorobei]

Here is the open PR to the Magento DevDocs magento/devdocs#4425 in order to change this statement.

[udovicic]

Makes sense, I will update as soon as I can.

[lenaorobei]

One more thing I didn't notice yesterday. Could you please move this rule to the different namespace, for example Commenting or DocBlock instead of PHP. Thank you!

[udovicic]

Hi @lenaorobei ,

Code has been refactored to comply with the examples provided, unit tests have been adjusted accordingly and the name space has been changed to Commenting.

[larsroettig]

Hi thanks for your contributions looks nice currently we can not add new rules to the repo because of versioning rules it can take some time before it will be merged.

This is an adding new rule, so it will be the part of the next major release.
I need to suspend the processing of current PR since the versioning strategy is not clear yet magento/architecture#136

[lenaorobei]

@udovicic thank you for this awesome contribution! 🚀
I added some minor fixes and going to merge the PR.