[plan] Fix 'Drupal.Commenting.FunctionComment' coding standard

Part of #2571965: [meta] Fix coding standards in core.

Approach

We are testing coding standards with PHP CodeSniffer, using the Drupal coding standards from the Coder module. Both of these packages are not installed in Drupal core. We need to do a couple of steps in order to download and configure them so we can run a coding standards check.

Step 1: Add the coding standard to the whitelist

Every coding standard is identified by a "sniff". For example, an imaginary coding standard that would require all llamas to be placed inside a square bracket fence would be called the "Drupal.AnimalControlStructure.BracketedFence sniff". There are dozens of such coding standards, and to make the work easier we have started by only whitelisting the sniffs that pass. For the moment all coding standards that are not yet fixed are simply skipped during the test.

Open the file core/phpcs.xml.dist and add a line for the sniff of this ticket. The sniff name is in the issue title. Make sure your patch will include the addition of this line.

Step 2: Install PHP CodeSniffer and the ruleset from the Coder module

Both of these packages are not installed by default in Drupal core, so we need to download them. This can be done with Composer, from the root folder of your Drupal installation:

$ composer require drupal/coder squizlabs/php_codesniffer
$ ./vendor/bin/phpcs --config-set installed_paths ../../drupal/coder/coder_sniffer

Once you have installed the phpcs package, you can list all the sniffs available to you like this:

$ ./vendor/bin/phpcs --standard=Drupal -e

This will give you a big list of sniffs, and the Drupal-based ones should be present.

Step 3: Prepare the phpcs.xml file

To speed up the testing you should make a copy of the file phpcs.xml.dist (in the core/ folder) and save it as phpcs.xml. This is the configuration file for PHP CodeSniffer.

We only want this phpcs.xml file to specify the sniff we're interested in. So we need to remove all the rule items, and add only our own sniff's rule. Rule items look like this:

<rule ref="Drupal.Classes.UnusedUseStatement"/>

Remove all of them, and add only the sniff from this issue title. This will make sure that our tests run quickly, and are not going to contain any output from unrelated sniffs.

Step 4: Run the test

Now you are ready to run the test! From within the core/ folder, run the following command to launch the test:

$ cd core/
$ ../vendor/bin/phpcs -p

This takes a couple of minutes. The -p flag shows the progress, so you have a bunch of nice dots to look at while it is running.

Step 5: Fix the failures

When the test is complete it will present you a list of all the files that contain violations of your sniff, and the line numbers where the violations occur. You could fix all of these manually, but thankfully phpcbf can fix many of them. You can call phpcbf like this:

$ ../vendor/bin/phpcbf

This will fix the errors in place. You can then make a diff of the changes using git. You can also re-run the test with phpcs and determine if that fixed all of them.

List of sub-sniffs related to Drupal.Commenting.FunctionComment

The following is the list of sub-sniffs related to Drupal.Commenting.FunctionComment. The number prefix is the number of failures for the sub-sniff in a run of coder on 8.2.x branch. The grouping is a proposed way of handling all the issues. Please remember to update specific issue numbers in the list below if any other sub-sniffs are taken up to avoid duplication of efforts.

Missing Function Comment

1479 Drupal.Commenting.FunctionComment.Missing

Missing Param Comment

119 Drupal.Commenting.FunctionComment.MissingParamComment

Missing Return Comment

398 Drupal.Commenting.FunctionComment.MissingReturnComment

Missing Return Type

259 Drupal.Commenting.FunctionComment.MissingReturnType

Missing Param Type

1010 Drupal.Commenting.FunctionComment.MissingParamType

Other Issues with Return Comment

8 Drupal.Commenting.FunctionComment.$InReturnType - #2721283: Fix Drupal.Commenting.FunctionComment.$InReturnType
24 Drupal.Commenting.FunctionComment.InvalidNoReturn - #2722647: Fix Drupal.Commenting.FunctionComment.InvalidNoReturn
2 Drupal.Commenting.FunctionComment.InvalidReturn - #2722621: Fix Drupal.Commenting.FunctionComment.InvalidReturn and Drupal.Commenting.FunctionComment.VoidReturn
11 Drupal.Commenting.FunctionComment.InvalidReturnNotVoid - #2722699: Fix Drupal.Commenting.FunctionComment.InvalidReturnNotVoid
42 Drupal.Commenting.FunctionComment.ReturnCommentIndentation - #2721909: Fix Drupal.Commenting.FunctionComment.ReturnCommentIndentation& #2902723: Fix 'Drupal.Commenting.FunctionComment.ReturnCommentIndentation' coding standard
1 Drupal.Commenting.FunctionComment.VoidReturn - #2722621: Fix Drupal.Commenting.FunctionComment.InvalidReturn and Drupal.Commenting.FunctionComment.VoidReturn
Drupal.Commenting.FunctionComment.ReturnTypeSpaces - #2803891: Fix 'Drupal.Commenting.FunctionComment.ReturnTypeSpaces' coding standard

Issues with Type Hint

31 Drupal.Commenting.FunctionComment.IncorrectTypeHint - #2723621: Fix Drupal.Commenting.FunctionComment.IncorrectTypeHint and Drupal.Commenting.FunctionComment.InvalidTypeHint
2 Drupal.Commenting.FunctionComment.InvalidTypeHint - #2723621: Fix Drupal.Commenting.FunctionComment.IncorrectTypeHint and Drupal.Commenting.FunctionComment.InvalidTypeHint
75 Drupal.Commenting.FunctionComment.TypeHintMissing

Other minor issues with Param Comment

8 Drupal.Commenting.FunctionComment.IncorrectParamVarName - #2715965: Fix 'Drupal.Commenting.FunctionComment.IncorrectParamVarName' coding standard
39 Drupal.Commenting.FunctionComment.MissingParamName - #2721901: Fix Drupal.Commenting.FunctionComment.MissingParamName
152 Drupal.Commenting.FunctionComment.ParamCommentFullStop - #2721309: Fix Drupal.Commenting.FunctionComment.ParamCommentFullStop
4 Drupal.Commenting.FunctionComment.ParamCommentNotCapital - #2902726: Fix 'Drupal.Commenting.FunctionComment.ParamCommentNotCapital' coding standard
Drupal.Commenting.FunctionComment.ParamCommentIndentation
Drupal.Commenting.FunctionComment.ParamMissingDefinition
39 Drupal.Commenting.FunctionComment.ParamNameNoMatch - #2722609: Fix Drupal.Commenting.FunctionComment.ParamNameNoMatch
Drupal.Commenting.FunctionComment.ParamTypeSpaces - #2803893: Fix 'Drupal.Commenting.FunctionComment.ParamTypeSpaces' coding standard

Issues with @see - #2716661: Fix 'Drupal.Commenting.FunctionComment' coding standard - Issues related to @see references

2 Drupal.Commenting.FunctionComment.SeeAdditionalText
29 Drupal.Commenting.FunctionComment.SeePunctuation

Spacing / Styling issues - #2708185: Fix 'Drupal.Commenting.FunctionComment' coding standard - Issues related to spacing and styling

7 Drupal.Commenting.FunctionComment.SpacingAfterParamType
1 Drupal.Commenting.FunctionComment.SpacingAfter
10 Drupal.Commenting.FunctionComment.ParamCommentNewLine - #2901665: Fix 'Drupal.Commenting.FunctionComment.ParamCommentNewLine' coding standard
8 Drupal.Commenting.FunctionComment.WrongStyle

Issues with @throws - #2708179: Fix 'Drupal.Commenting.FunctionComment' coding standard - Issues related to @throws

5 Drupal.Commenting.FunctionComment.ThrowsComment
4 Drupal.Commenting.FunctionComment.ThrowsNoFullStop
1 Drupal.Commenting.FunctionComment.ThrowsNotCapital