From 67c1bcf2d6860237ce4b176fd55ef4c7c014d84e Mon Sep 17 00:00:00 2001
From: Klaus Purer <klaus.purer@protonmail.ch>
Date: Wed, 4 Nov 2020 15:55:07 +0100
Subject: [PATCH] docs(InlineVariableComment): Add inline code comment
(#3177757)
---
.../Drupal/Sniffs/Commenting/InlineVariableCommentSniff.php | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/InlineVariableCommentSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/InlineVariableCommentSniff.php
index fb14ac38..814b711d 100644
--- a/coder_sniffer/Drupal/Sniffs/Commenting/InlineVariableCommentSniff.php
+++ b/coder_sniffer/Drupal/Sniffs/Commenting/InlineVariableCommentSniff.php
@@ -84,6 +84,9 @@ class InlineVariableCommentSniff implements Sniff
$warning = 'Inline @var declarations should use the /** */ delimiters';
if (strpos($tokens[$stackPtr]['content'], '#') === 0 || strpos($tokens[$stackPtr]['content'], '//') === 0) {
+ // If this comment contains '*/' then the developer is mixing
+ // inline comment styles. This could be commented out code,
+ // so leave this line alone completely.
if (strpos($tokens[$stackPtr]['content'], '*/') !== false) {
return;
}
@@ -102,7 +105,7 @@ class InlineVariableCommentSniff implements Sniff
if ($phpcsFile->addFixableWarning($warning, $stackPtr, 'VarInline') === true) {
$phpcsFile->fixer->replaceToken($stackPtr, substr_replace($tokens[$stackPtr]['content'], '/**', 0, 2));
}
- }
+ }//end if
}//end if
return;
--
GitLab