Merge pull request #2371 from retailcoder/next

fix for HasComment and non-standard REM comments

Author: retailcoder

Rubberduck.Parsing/VBA/StringExtensions.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Text.RegularExpressions;
@@ -8,7 +9,35 @@ namespace Rubberduck.Parsing.VBA
 {
     public static class StringExtensions
     {
-
+        // see issues #1057 and #2364.
+        private static readonly IList<string> ValidRemCommentMarkers =
+            new List<string>
+            {
+                Tokens.Rem + ' ',
+                Tokens.Rem + '?',
+                Tokens.Rem + '<',
+                Tokens.Rem + '>',
+                Tokens.Rem + '{',
+                Tokens.Rem + '}',
+                Tokens.Rem + '~',
+                Tokens.Rem + '`',
+                Tokens.Rem + '!',
+                Tokens.Rem + '/',
+                Tokens.Rem + '*',
+                Tokens.Rem + '(',
+                Tokens.Rem + ')',
+                Tokens.Rem + '-',
+                Tokens.Rem + '=',
+                Tokens.Rem + '+',
+                Tokens.Rem + '\\',
+                Tokens.Rem + '|',
+                Tokens.Rem + ';',
+                Tokens.Rem + ':',
+                Tokens.Rem + '\'',
+                Tokens.Rem + '"',
+                Tokens.Rem + ',',
+                Tokens.Rem + '.',
+            };
 
         /// <summary>
         /// Returns a value indicating whether line of code is/contains a comment.
@@ -23,11 +52,22 @@ public static bool HasComment(this string line, out int index)
             index = instruction.IndexOf(Tokens.CommentMarker, StringComparison.InvariantCulture);
             if (index >= 0)
             {
+                // line contains a single-quote comment marker
                 return true;
             }
 
-            index = instruction.IndexOf(Tokens.Rem + " ", StringComparison.InvariantCulture);
-            return index >= 0;
+            // note: REM comment markers are NOT implemented as per language specifications.
+            // ReSharper disable once ForCanBeConvertedToForeach
+            for (var i = 0; i < ValidRemCommentMarkers.Count; i++)
+            {
+                index = instruction.IndexOf(ValidRemCommentMarkers[i], StringComparison.InvariantCulture);
+                if (index >= 0)
+                {
+                    return true;
+                }
+            }
+
+            return false;
         }
 
         public static string StripStringLiterals(this string line)

RubberduckTests/StringExtensionsTests.cs

@@ -33,7 +33,7 @@ public void StripsAllStringLiterals()
         }
 
         [TestMethod]
-        public void IsComment()
+        public void IsComment_StartLineWithSingleQuoteMarker()
         {
             var instruction = "'Debug.Print mwahaha this is just a comment.";
 
@@ -45,7 +45,7 @@ public void IsComment()
         }
 
         [TestMethod]
-        public void HasComment()
+        public void HasComment_EndOfLineSingleQuoteMarkerWithStringLiteral()
         {
             var comment = "'but this is one.";
             var instruction = "Debug.Print \"'this isn't a comment\" " + comment;
@@ -57,6 +57,32 @@ public void HasComment()
             Assert.AreEqual(comment, instruction.Substring(index));
         }
 
+        [TestMethod]
+        public void HasComment_RemMarkerWithWhitespace()
+        {
+            var comment = "Rem this is a comment.";
+            var instruction = "Debug.Print \"'this isn't a comment\" : " + comment;
+
+            int index;
+            var result = instruction.HasComment(out index);
+
+            Assert.IsTrue(result);
+            Assert.AreEqual(comment, instruction.Substring(index));
+        }
+
+        [TestMethod]
+        public void HasComment_RemMarkerWithQuestionMark()
+        {
+            var comment = "Rem?this is a comment.";
+            var instruction = comment;
+
+            int index;
+            var result = instruction.HasComment(out index);
+
+            Assert.IsTrue(result);
+            Assert.AreEqual(comment, instruction.Substring(index));
+        }
+
         [TestMethod]
         public void CaseInsensitiveContainsShouldReturnTrue()
         {