C#: Do not extract comments when scaffolding.

Author: michaelnebel

csharp/extractor/Semmle.Extraction.CSharp/Entities/Base/CachedSymbol.cs

@@ -109,7 +109,7 @@ public virtual IEnumerable<Location> Locations
         /// </summary>
         protected void BindComments()
         {
-            if (!Symbol.IsImplicitlyDeclared && IsSourceDeclaration && Symbol.FromSource() && !Context.OnlyScaffold)
+            if (!Symbol.IsImplicitlyDeclared && IsSourceDeclaration && Symbol.FromSource())
                 Context.BindComments(this, FullLocation);
         }
 

csharp/extractor/Semmle.Extraction.CSharp/Entities/CommentBlock.cs

@@ -10,12 +10,12 @@ private CommentBlock(Context cx, Comments.CommentBlock init)
 
         public override void Populate(TextWriter trapFile)
         {
-            trapFile.commentblock(this);
-            Symbol.CommentLines.ForEach((l, child) => trapFile.commentblock_child(this, l, child));
             if (Context.OnlyScaffold)
             {
                 return;
             }
+            trapFile.commentblock(this);
+            Symbol.CommentLines.ForEach((l, child) => trapFile.commentblock_child(this, l, child));
             WriteLocationToTrap(trapFile.commentblock_location, this, Context.CreateLocation(Symbol.Location));
         }
 
@@ -31,6 +31,10 @@ public override void WriteId(EscapingTextWriter trapFile)
 
         public void BindTo(Label entity, CommentBinding binding)
         {
+            if (Context.OnlyScaffold)
+            {
+                return;
+            }
             Context.TrapWriter.Writer.commentblock_binding(this, entity, binding);
         }
 

csharp/extractor/Semmle.Extraction.CSharp/Entities/CommentLine.cs

@@ -21,11 +21,11 @@ private CommentLine(Context cx, Microsoft.CodeAnalysis.Location loc, CommentLine
 
         public override void Populate(TextWriter trapFile)
         {
-            trapFile.commentline(this, Type == CommentLineType.MultilineContinuation ? CommentLineType.Multiline : Type, Text, RawText);
             if (Context.OnlyScaffold)
             {
                 return;
             }
+            trapFile.commentline(this, Type == CommentLineType.MultilineContinuation ? CommentLineType.Multiline : Type, Text, RawText);
             location = Context.CreateLocation(Location);
             WriteLocationToTrap(trapFile.commentline_location, this, location);
 

csharp/extractor/Semmle.Extraction.CSharp/Extractor/Context.cs

@@ -631,6 +631,10 @@ public Entities.Location CreateLocation(Microsoft.CodeAnalysis.Location? locatio
         /// <param name="l">Location of the entity.</param>
         public void BindComments(Entity entity, Microsoft.CodeAnalysis.Location? l)
         {
+            if (OnlyScaffold)
+            {
+                return;
+            }
             var duplicationGuardKey = GetCurrentTagStackKey();
             CommentGenerator.AddElement(entity.Label, duplicationGuardKey, l);
         }

csharp/extractor/Semmle.Extraction.CSharp/Populators/CommentPopulator.cs

@@ -12,6 +12,10 @@ internal static class CommentPopulator
     {
         public static void ExtractCommentBlocks(Context cx, CommentProcessor gen)
         {
+            if (cx.OnlyScaffold)
+            {
+                return;
+            }
             cx.Try(null, null, () =>
             {
                 gen.GenerateBindings((entity, duplicationGuardKey, block, binding) =>
@@ -34,6 +38,10 @@ public static void ExtractCommentBlocks(Context cx, CommentProcessor gen)
 
         public static void ExtractComment(Context cx, SyntaxTrivia trivia)
         {
+            if (cx.OnlyScaffold)
+            {
+                return;
+            }
             switch (trivia.Kind())
             {
                 case SyntaxKind.SingleLineDocumentationCommentTrivia: