C# auto-generated header for generated c# codec files (#814)

mhoogveld · web-flow · commit 7f00e1fe1615 · 2020-09-15T07:54:42.000+01:00
* Added "auto-generated" tag which is recognized by Visual Studio at the top of each generated C# file.
Auto-generated files are not included in automatic code-cleanup and/or inspection processes.

* Renamed all generated *.cs files to *.g.cs
Like the auto-generated tag in the file's header, this causes files to be recognized as auto-generated code by Visual Studio.
An added bonus of the filename change is that these files can be treated differently based on the filename in your project's .gitignore or .editorconfig files
diff --git a/sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/csharp/CSharpGenerator.java b/sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/csharp/CSharpGenerator.java
@@ -614,7 +614,9 @@ private CharSequence generateFileHeader(final String packageName)
         }
 
         return String.format(
-            "/* Generated SBE (Simple Binary Encoding) message codec */\n\n" +
+            "// <auto-generated>\n" +
+            "//     Generated SBE (Simple Binary Encoding) message codec\n" +
+            "// </auto-generated>\n\n" +
             "#pragma warning disable 1591 // disable warning on missing comments\n" +
             "using System;\n" +
             "using Org.SbeTool.Sbe.Dll;\n\n" +
diff --git a/sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/csharp/CSharpNamespaceOutputManager.java b/sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/csharp/CSharpNamespaceOutputManager.java
@@ -71,7 +71,7 @@ public CSharpNamespaceOutputManager(final String baseDirName, final String packa
      */
     public Writer createOutput(final String name) throws IOException
     {
-        final File targetFile = new File(outputDir, name + ".cs");
+        final File targetFile = new File(outputDir, name + ".g.cs");
         return Files.newBufferedWriter(targetFile.toPath(), StandardCharsets.UTF_8);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public CSharpNamespaceOutputManager(final String baseDirName, final String packa`
`71`	`71`	`*/`
`72`	`72`	`public Writer createOutput(final String name) throws IOException`
`73`	`73`	`{`
`74`		`- final File targetFile = new File(outputDir, name + ".cs");`
	`74`	`+ final File targetFile = new File(outputDir, name + ".g.cs");`
`75`	`75`	`return Files.newBufferedWriter(targetFile.toPath(), StandardCharsets.UTF_8);`
`76`	`76`	`}`
`77`	`77`	`}`