Warning raised if class member already have meaningful description

Author: konarshankar07

Magento2/Sniffs/Commenting/ClassPropertyPHPDocFormattingSniff.php

@@ -66,6 +66,14 @@ public function processMemberVar(File $phpcsFile, $stackPtr)
             $phpcsFile->addWarning($error, $foundVar, 'EmptyVar');
             return;
         }
+
+        // Check if class has already have meaningful description
+        $isShortDescription = $phpcsFile->findPrevious(T_DOC_COMMENT_STRING, $commentEnd, $foundVar, false);
+        if ($tokens[$string]['line'] !==  $tokens[$isShortDescription]['line']) {
+            $error = 'Variable member already have meaningful name';
+            $phpcsFile->addWarning($error, $isShortDescription, 'AlreadyMeaningFulNameVar');
+            return;
+        }
     }
 
     /**

Magento2/Tests/Commenting/ClassPropertyPHPDocFormattingUnitTest.inc

@@ -37,23 +37,41 @@ class Foo
 class Bar {
 
     /**
-     * @var correctlyFormattedPublicClassMember
+     * @var variablehasAlreadyhaveProtectedClassMember
      *
      * Short Description
      */
-    public $correctlyFormattedPublicClassMember;
+    public $variablehasAlreadyhavePublicClassMember;
 
     /**
-     * @var correctlyFormattedPrivateClassMember
+     * @var variablehasAlreadyhavePrivateClassMember
      *
      * Short Description
      */
-    private $correctlyFormattedPrivateClassMember;
+    private $variablehasAlreadyhavePrivateClassMember;
 
     /**
-     * @var correctlyFormattedProtectedClassMember
+     * @var variablehasAlreadyhaveProtectedClassMember
      *
      * Short Description
      */
+    protected $variablehasAlreadyhaveProtectedClassMember;
+}
+
+class correctlyFormattedClassMemberDocBlock
+{
+    /**
+     * @var correctlyFormattedPublicClassMember
+     */
+    public $correctlyFormattedPublicClassMember;
+
+    /**
+     * @var correctlyFormattedPrivateClassMember
+     */
+    private $correctlyFormattedPrivateClassMember;
+
+    /**
+     * @var correctlyFormattedProtectedClassMember
+     */
     protected $correctlyFormattedProtectedClassMember;
 }

Magento2/Tests/Commenting/ClassPropertyPHPDocFormattingUnitTest.php

@@ -24,9 +24,13 @@ public function getWarningList()
     {
         return [
             13 => 1,
+            18 => 1,
             23 => 1,
-            30 => 1,
-            34 => 1
+            30 => 2,
+            34 => 1,
+            42 => 1,
+            49 => 1,
+            56 => 1
         ];
     }
 }