We are writing a lot of boiler plate code that doesn't really help anyone from a comments perspective when using types
/**
* Example Command to sanitize.
*
* @see \Drush\Drupal\Commands\sql\SanitizeSessionsCommands
* @see \Drush\Drupal\Commands\sql\SanitizeUserTableCommands
*/
class ExampleCommand extends DrushCommands implements SanitizePluginInterface {
/**
* DB connection.
*
* @var \Drupal\Core\Database\Connection
*/
protected Connection $database;
/**
* Password.
*
* @var \Drupal\Core\Password\PhpassHashedPassword
*/
protected PhpassHashedPassword $password;
/**
* Entity Type Manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected EntityTypeManagerInterface $entityTypeManager;
/**
* Config Factory interface.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected ConfigFactoryInterface $configFactory;
/**
* Construct.
*
* @param \Drupal\Core\Database\Connection $database
* DB connection.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
* Entity Type Manager.
* @param \Drupal\Core\Password\PhpassHashedPassword $password
* Password.
* @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
* Config Factory.
*/
public function __construct(Connection $database, EntityTypeManagerInterface $entityTypeManager, PhpassHashedPassword $password, ConfigFactoryInterface $configFactory) {
$this->database = $database;
$this->entityTypeManager = $entityTypeManager;
$this->password = $password;
$this->configFactory = $configFactory;
}
/**
* Get the body of the node.
*
* @param \Drupal\node\NodeInterface
* Node.
*
* @return string
* Body.
*/
public function getBody(NodeInterface $node): string {
return $node->body->value;
}
}
There are almost no useful comments above. It is example code and it is more illustrative than real. But with strict typing, most comments are just a duplicate nightmare for the developer.
It would be nice to be able to write the above as:
/**
* Example Command to sanitize.
*
* @see \Drush\Drupal\Commands\sql\SanitizeSessionsCommands
* @see \Drush\Drupal\Commands\sql\SanitizeUserTableCommands
*/
class ExampleCommand extends DrushCommands implements SanitizePluginInterface {
protected Connection $database;
protected PhpassHashedPassword $password;
protected EntityTypeManagerInterface $entityTypeManager;
protected ConfigFactoryInterface $configFactory;
public function __construct(Connection $database, EntityTypeManagerInterface $entityTypeManager, PhpassHashedPassword $password, ConfigFactoryInterface $configFactory) {
$this->database = $database;
$this->entityTypeManager = $entityTypeManager;
$this->password = $password;
$this->configFactory = $configFactory;
}
public function getBody(NodeInterface $node): string {
return $node->body->value;
}
}
It seems like a lot of time is spent scaffolding comments needlessly with 7.4 and above.
Proposal:
- If a variable is typed and named meaningfully then a comment is not necessary (not sure how this would be enforced)
Closed: duplicate
Coding Standards
Not all content is available!
It's likely this issue predates Contrib.social: some issue and comment data are missing.
@timodwhit and @drunken monkey, thanks for working on this.
I am going to close this because of the related issues. Apologies if I missed a point that is not covered in those or an existing issue. If I did it would be best to open a new issue for each point so that the new issue template is used.
Thanks!