Skip to content
Snippets Groups Projects
Alberto Paderno's avatar
opened merge request !4 "Created a new merge request to get the list of the PHP_CodeSniffer errors/warnings to fix" at project / visualization
Alberto Paderno's avatar
Alberto Paderno's avatar
joined project project / visualization
Alberto Paderno's avatar
commented on merge request !3 "3162002-phpcs Drupal standards" at project / visualization

The usual description for a .module file is Hook implementations for the [module name] module. where [module name] is the name of the module given ...

Alberto Paderno's avatar
commented on merge request !3 "3162002-phpcs Drupal standards" at project / visualization

Only a documentation comment is added per function/method/class.

Alberto Paderno's avatar
commented on merge request !3 "3162002-phpcs Drupal standards" at project / visualization

@file is not used in files containing a single class definition.

Alberto Paderno's avatar
commented on merge request !3 "3162002-phpcs Drupal standards" at project / visualization

This line must be removed.

Alberto Paderno's avatar
commented on merge request !3 "3162002-phpcs Drupal standards" at project / visualization

That would be the description for a return value. For properties, the description is given before the @var line.

Alberto Paderno's avatar
commented on merge request !3 "3162002-phpcs Drupal standards" at project / visualization

The property description is given only once, before the @var line.

Alberto Paderno's avatar
commented on merge request !3 "3162002-phpcs Drupal standards" at project / visualization

The description must be more... descriptive, not repeating the property name....

Alberto Paderno's avatar
commented on merge request !3 "3162002-phpcs Drupal standards" at project / visualization

The description must avoid to repeat the property name....

Alberto Paderno's avatar
commented on merge request !3 "3162002-phpcs Drupal standards" at project / visualization

Since this is a public function, this change is not backward compatible. Although the new method name is correct, there could be other modules that...

Alberto Paderno's avatar
commented on merge request !3 "3162002-phpcs Drupal standards" at project / visualization

Since this is an inherited method (from a parent class or an interface), the documentation comment must be different.

Alberto Paderno's avatar
commented on merge request !3 "3162002-phpcs Drupal standards" at project / visualization

The documentation comment for constructors is not anymore mandatory.

Alberto Paderno's avatar
commented on merge request !3 "3162002-phpcs Drupal standards" at project / visualization

The description should not repeat the class name, even when spaces are added.

Alberto Paderno's avatar
commented on merge request !3 "3162002-phpcs Drupal standards" at project / visualization

FALSE is used only in PHP code; in JavaScript code, it is correct to use false.

Rashmi's avatar
opened merge request !3 "3162002-phpcs Drupal standards" at project / visualization
Rashmi's avatar
opened merge request !2 "2844457-->t() should be used instead of t() for Drupal 8 version" at project / visualization
Urvashi Vora's avatar
opened merge request !1 "Issue #2844455: Remove @file tag docblock from all the .php files" at project / visualization