Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Sometimes I've found it useful to put comments into the code that likely should be omitted from the final published version of the code. These comments may reference something discussed in IRC or in the Issue thread, but once the patch is incorporated into core they would be at best a nuisance and at worst a source of confusion. Currently there is no clean way to label such comments.
Since they aren't used in any other context in the Drupal coding standards this meta issue proposes using the Perl style comment tags like so.
/**
* A methods name
*/
protected function foo() {
# Trying this technique we discussed yesterday in IRC - let's see
# if it helps.
}
This makes it very clear very quickly which comments are to be kept in the final draft of the patch.
Thoughts?
Comments
Comment #9
quietone CreditAttribution: quietone as a volunteer commentedAn interesting idea but Perl style comments are not allowed and will be flagged as an error with the commit check script, Committer checks added to DrupalCI tests for Drupal Core.
Therefore, closing as outdated. If this is incorrect reopen the issue, by setting the status to 'Active', and add a comment explaining what still needs to be done.
Thanks!