From 149e25021fc64b1ab08b435657ab379e50ccec8f Mon Sep 17 00:00:00 2001 From: Maarten Hoogveld Date: Fri, 21 Aug 2020 16:24:35 +0200 Subject: [PATCH 1/2] 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. --- .../co/real_logic/sbe/generation/csharp/CSharpGenerator.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) 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 index e3671c14c0..1a45d845c0 100644 --- 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" + + "// \n" + + "// Generated SBE (Simple Binary Encoding) message codec\n" + + "// \n\n" + "#pragma warning disable 1591 // disable warning on missing comments\n" + "using System;\n" + "using Org.SbeTool.Sbe.Dll;\n\n" + From 09d1811aeff952431da805f2d87252b6c38f7405 Mon Sep 17 00:00:00 2001 From: Maarten Hoogveld Date: Fri, 21 Aug 2020 16:30:08 +0200 Subject: [PATCH 2/2] 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 --- .../sbe/generation/csharp/CSharpNamespaceOutputManager.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 index 389d942fc4..b3d7c20c26 100644 --- 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); } }