added html comments to custom css/js tags

Author: MehdiK

TestStack.BDDfy/Processors/Reporters/Html/HtmlReportBuilder.cs

@@ -41,7 +41,7 @@ private void HtmlHead()
             {
                 AddLine("<meta charset='utf-8'/>");
                 EmbedCssFile(HtmlReportResources.BDDfy_css);
-                EmbedCssFile(_viewModel.CustomStylesheet);
+                EmbedCssFile(_viewModel.CustomStylesheet, HtmlReportResources.CustomStylesheetComment);
 
                 AddLine(string.Format("<title>BDDfy Test Result {0}</title>", DateTime.Now.ToShortDateString()));
             }
@@ -139,7 +139,7 @@ private void Footer()
 
             AddLine("<script type='text/javascript' src='https://code.jquery.com/jquery-1.11.0.min.js'></script>");
             EmbedJavascriptFile(HtmlReportResources.BDDfy_js);
-            EmbedJavascriptFile(_viewModel.CustomJavascript);
+            EmbedJavascriptFile(_viewModel.CustomJavascript, HtmlReportResources.CustomJavascriptComment);
         }
 
         private void AddStory(Story story)
@@ -264,20 +264,31 @@ private void AddLine(string line)
             _html.AppendLine(string.Empty.PadLeft(tabWidth) + line);
         }
 
-        private void EmbedCssFile(string cssContent)
+        private void EmbedCssFile(string cssContent, string htmlComment = null)
         {
             using (OpenTag("<style type='text/css'>", HtmlTag.style))
             {
+                AddHtmlComment(htmlComment);
                 _html.AppendLine(cssContent);
             }
         }
 
-        private void EmbedJavascriptFile(string javascriptContent)
+        private void EmbedJavascriptFile(string javascriptContent, string htmlComment = null)
         {
             using (OpenTag(HtmlTag.script))
             {
+                AddHtmlComment(htmlComment);
                 _html.AppendLine(javascriptContent);
             }
         }
+
+        private void AddHtmlComment(string htmlComment)
+        {
+            if (string.IsNullOrWhiteSpace(htmlComment))
+                return;
+
+            _html.AppendFormat("/*{0}*/", htmlComment);
+            _html.AppendLine();
+        }
     }
 }

TestStack.BDDfy/Processors/Reporters/Html/HtmlReportResources.Designer.cs

@@ -124,4 +124,10 @@
   <data name="BDDfy_js" type="System.Resources.ResXFileRef, System.Windows.Forms">
     <value>BDDfy.js;System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089;utf-8</value>
   </data>
+  <data name="CustomJavascriptComment" xml:space="preserve">
+    <value>If you drop a custom Javascript named BDDfyCustom.js in your output folder it gets embedded here. This way you can apply some custom Javascript logic to your html report.</value>
+  </data>
+  <data name="CustomStylesheetComment" xml:space="preserve">
+    <value>If you drop a custom stylesheet named BDDfyCustom.css in your output folder it gets embedded here. This way you can apply some custom styles over your html report.</value>
+  </data>
 </root>