Add comments option

Dotnet-Boxed · Mar 18, 2022 · 7556c4b · 7556c4b
1 parent 68415cf
commit 7556c4b
Show file tree

Hide file tree

Showing 10 changed files with 28 additions and 6 deletions.
diff --git a/Source/NuGetTemplate/.editorconfig b/Source/NuGetTemplate/.editorconfig
@@ -418,6 +418,18 @@ dotnet_naming_rule.parameters_rule.severity             = warning
 ##########################################
 
 [*.cs]
+#if (!Comments)
+# SA0001: XML comment analysis is disabled due to project configuration
+# Justification: Comments turned off
+# https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA0001.md
+dotnet_diagnostic.SA0001.severity = none
+
+# SA1600: Elements should be documented.
+# Justification: Comments turned off
+# https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1600.md
+dotnet_diagnostic.SA1600.severity = none
+
+#endif
 # SA1633: A C# code file is missing a standard file header.
 # Justification: Comments turned off
 # https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1633.md

diff --git a/Source/NuGetTemplate/.template.config/dotnetcli.host.json b/Source/NuGetTemplate/.template.config/dotnetcli.host.json
@@ -40,6 +40,9 @@
     "ContactXmlEncoded": {
       "isHidden": true
     },
+    "Comments": {
+      "longName": "comments"
+    },
     "ReadMe": {
       "longName": "readme"
     },

diff --git a/Source/NuGetTemplate/.template.config/template.json b/Source/NuGetTemplate/.template.config/template.json
@@ -226,6 +226,13 @@
       "valueSource": "Contact",
       "valueTransform": "xmlEncode"
     },
+    "Comments": {
+      "type": "parameter",
+      "datatype": "bool",
+      "defaultValue": "true",
+      "displayName": "Comments",
+      "description": "Require comments on all code."
+    },
     "ReadMe": {
       "type": "parameter",
       "datatype": "bool",

diff --git a/Source/NuGetTemplate/Directory.Build.props b/Source/NuGetTemplate/Directory.Build.props
@@ -5,6 +5,7 @@
     <AnalysisMode>AllEnabledByDefault</AnalysisMode>
     <DotnetFramework>false</DotnetFramework>
     <EditorConfig>true</EditorConfig>
+    <ImplicitUsings>true</ImplicitUsings>
     <MIT>true</MIT>
     <Nullable>true</Nullable>
     <StyleCop>true</StyleCop>

diff --git a/Source/NuGetTemplate/Source/Directory.Build.props b/Source/NuGetTemplate/Source/Directory.Build.props
@@ -12,7 +12,7 @@
 
   <PropertyGroup Label="Build">
     <IsTrimmable Condition="'$(IsTrimmable)' == 'true'">true</IsTrimmable>
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <GenerateDocumentationFile Condition="'$(Comments)' == 'true'">true</GenerateDocumentationFile>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
   </PropertyGroup>
 

diff --git a/Source/NuGetTemplate/Source/NuGetTemplate/Class1.cs b/Source/NuGetTemplate/Source/NuGetTemplate/Class1.cs
@@ -1,8 +1,10 @@
 namespace NuGetTemplate;
 
+#if Comments
 /// <summary>
 /// Some class.
 /// </summary>
+#endif
 public class Class1
 {
 }
diff --git a/Source/NuGetTemplate/Source/NuGetTemplate/NuGetTemplate.csproj b/Source/NuGetTemplate/Source/NuGetTemplate/NuGetTemplate.csproj
@@ -2,7 +2,7 @@
   <!--#if (AuthoringMode)-->
   <PropertyGroup>
     <!-- Modify these constants to enable/disable a feature to debug the template. Note that this only affects the C#. -->
-    <DefineConstants>$(DefineConstants);</DefineConstants>
+    <DefineConstants>$(DefineConstants);Comments</DefineConstants>
     <!-- Workaround to build this project: https://github.com/dotnet/templating/issues/1438 -->
     <Framework>net6.0</Framework>
   </PropertyGroup>

diff --git a/Source/NuGetTemplate/Source/NuGetTemplate/Properties/AssemblyInfo.cs b/Source/NuGetTemplate/Source/NuGetTemplate/Properties/AssemblyInfo.cs
@@ -1,3 +1 @@
-using System;
-
 [assembly: CLSCompliant(true)]
diff --git a/Source/NuGetTemplate/Tests/NuGetTemplate.Test/Properties/AssemblyInfo.cs b/Source/NuGetTemplate/Tests/NuGetTemplate.Test/Properties/AssemblyInfo.cs
@@ -1,3 +1 @@
-using System;
-
 [assembly: CLSCompliant(true)]
diff --git a/Tests/Boxed.Templates.FunctionalTest/NuGetTemplateTest.cs b/Tests/Boxed.Templates.FunctionalTest/NuGetTemplateTest.cs
@@ -32,6 +32,7 @@ public NuGetTemplateTest(ITestOutputHelper testOutputHelper)
     [InlineData("NuGetAnalysisNone", "analysis-mode=AllDisabledByDefault")]
     [InlineData("NuGetNoImplicitUsings", "implicit-usings=false")]
     [InlineData("NuGetTrimmable", "trimmable=true")]
+    [InlineData("NuGetNoComments", "comments=false")]
     public async Task RestoreBuildTest_NuGetDefaults_SuccessfulAsync(string name, params string[] arguments)
     {
         await InstallTemplateAsync().ConfigureAwait(false);