Use resx comment - clean up

Author: aritchie

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Allan Ritchie
+Copyright (c) 2026 Allan Ritchie
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Shiny.Extensions.Localization.Generator.Tests/LocalizationSourceGeneratorTests.CommentsInResxFileTest#CommentsTest.StringsLocalized.g.verified.cs

@@ -0,0 +1,59 @@
+//HintName: CommentsTest.StringsLocalized.g.cs
+namespace CommentsTest;
+
+public partial class StringsLocalized
+{
+	readonly global::Microsoft.Extensions.Localization.IStringLocalizer localizer;
+
+	public StringsLocalized(global::Microsoft.Extensions.Localization.IStringLocalizer<global::CommentsTest.Strings> localizer)
+	{
+		this.localizer = localizer;
+	}
+
+	public global::Microsoft.Extensions.Localization.IStringLocalizer Localizer => this.localizer;
+
+	/// <summary>
+	/// Displayed on the home screen when user first opens the app
+	/// </summary>
+	public string WelcomeMessage => this.localizer["WelcomeMessage"];
+	/// <summary>
+	/// Goodbye and see you later
+	/// </summary>
+	public string GoodbyeMessage => this.localizer["GoodbyeMessage"];
+	/// <summary>
+	/// Greeting message where {0} is the user&apos;s name
+	/// </summary>
+	public string GreetingFormat(object parameter0)
+	{
+		return string.Format(this.localizer["GreetingFormat"], parameter0);
+	}
+
+	/// <summary>
+	/// Goodbye {0}, see you tomorrow!
+	/// </summary>
+	public string FarewellFormat(object parameter0)
+	{
+		return string.Format(this.localizer["FarewellFormat"], parameter0);
+	}
+
+	/// <summary>
+	/// Full greeting with user name, message count, and sender name
+	/// </summary>
+	public string DetailedGreetingFormat(object parameter0, object parameter1, object parameter2)
+	{
+		return string.Format(this.localizer["DetailedGreeting"], parameter0, parameter1, parameter2);
+	}
+
+	/// <summary>
+	/// Comment with &lt;special&gt; &amp; &quot;characters&quot; to &apos;escape&apos;
+	/// </summary>
+	public string SpecialComment => this.localizer["SpecialComment"];
+	/// <summary>
+	/// Shows the current date in long format
+	/// </summary>
+	public string DateGreetingFormat(object parameter0)
+	{
+		return string.Format(this.localizer["DateGreeting"], parameter0);
+	}
+
+}

Shiny.Extensions.Localization.Generator.Tests/LocalizationSourceGeneratorTests.CommentsInResxFileTest#ServiceCollectionExtensions.g.verified.cs

@@ -0,0 +1,17 @@
+//HintName: ServiceCollectionExtensions.g.cs
+// <auto-generated />
+// This file is auto-generated by Shiny.Extensions.Localization.Generator
+// Do not edit this file directly, instead edit the .resx files in your project.
+using global::Microsoft.Extensions.DependencyInjection;
+
+namespace CommentsTest;
+
+public static class ServiceCollectionExtensions_Generated
+{
+	public static global::Microsoft.Extensions.DependencyInjection.IServiceCollection AddStronglyTypedLocalizations(this global::Microsoft.Extensions.DependencyInjection.IServiceCollection services)
+	{
+		services.AddLocalization();
+		services.AddSingleton<global::CommentsTest.StringsLocalized>();
+		return services;
+	}
+}

Shiny.Extensions.Localization.Generator.Tests/LocalizationSourceGeneratorTests.FormatParametersWithFormattingOptionsTest#FormattingTest.FormattingLocalized.g.verified.cs

@@ -47,7 +47,7 @@ public string NumberFormatMessageFormat(object parameter0)
 	/// <summary>
 	/// Event scheduled for {0:yyyy-MM-dd HH:mm:ss}
 	/// </summary>
-	public string CustomDateTimeFormatFormat(object parameter0)
+	public string CustomDateTimeFormat(object parameter0)
 	{
 		return string.Format(this.localizer["CustomDateTimeFormat"], parameter0);
 	}

Shiny.Extensions.Localization.Generator.Tests/LocalizationSourceGeneratorTests.cs

@@ -193,4 +193,51 @@ public async Task FormatParametersWithFormattingOptionsTest()
         await Verify(results)
             .UseMethodName("FormatParametersWithFormattingOptionsTest");
     }
+
+    [Fact]
+    public async Task CommentsInResxFileTest()
+    {
+        var compilation = CSharpCompilation.Create(
+            assemblyName: "Tests"
+        );
+        var generator = new LocalizationSourceGenerator().AsSourceGenerator();
+        var options = new TestAnalyzerConfigOptionsProvider();
+        options.Options.Add("build_property.MSBuildProjectFullPath", "Shiny.Extensions.Localization.Generator");
+        options.Options.Add("build_property.MSBuildProjectName", "CommentsTest");
+
+        var resource1 = new ResxAdditionalText("Strings.resx");
+        
+        // Simple property with comment - should use comment in summary
+        resource1.AddStringWithComment("WelcomeMessage", "Welcome to our application", "Displayed on the home screen when user first opens the app");
+        
+        // Simple property without comment - should fall back to value
+        resource1.AddString("GoodbyeMessage", "Goodbye and see you later");
+        
+        // Format method with comment - should use comment in summary
+        resource1.AddStringWithComment("GreetingFormat", "Hello {0}!", "Greeting message where {0} is the user's name");
+        
+        // Format method without comment - should fall back to value
+        resource1.AddString("FarewellFormat", "Goodbye {0}, see you tomorrow!");
+        
+        // Multiple parameters with comment
+        resource1.AddStringWithComment("DetailedGreeting", "Hello {0}, you have {1} new messages from {2}", "Full greeting with user name, message count, and sender name");
+        
+        // Comment with special characters that need XML escaping
+        resource1.AddStringWithComment("SpecialComment", "Test value", "Comment with <special> & \"characters\" to 'escape'");
+        
+        // Format with formatting options and comment
+        resource1.AddStringWithComment("DateGreeting", "Today is {0:MMMM dd, yyyy}", "Shows the current date in long format");
+
+        GeneratorDriver driver = CSharpGeneratorDriver.Create(
+            [generator],
+            optionsProvider: options,
+            additionalTexts: ImmutableArray.Create<AdditionalText>(resource1)
+        );
+
+        driver = driver.RunGenerators(compilation);
+        var results = driver.GetRunResult();
+
+        await Verify(results)
+            .UseMethodName("CommentsInResxFileTest");
+    }
 }

Shiny.Extensions.Localization.Generator.Tests/ResxAdditionalText.cs

@@ -1,4 +1,5 @@
-using System.Text;
+using System.Text;
+using System.Security;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Text;
 
@@ -7,12 +8,18 @@ namespace Shiny.Extensions.Localization.Generator.Tests;
 
 public class ResxAdditionalText : AdditionalText
 {
-	readonly Dictionary<string, string> strings = new();
+	readonly Dictionary<string, (string Value, string? Comment)> strings = new();
 	public ResxAdditionalText(string path) => this.Path = path;
 
     public ResxAdditionalText AddString(string key, string value)
 	{
-		this.strings.Add(key, value);
+		this.strings.Add(key, (value, null));
+		return this;
+	}
+
+    public ResxAdditionalText AddStringWithComment(string key, string value, string comment)
+	{
+		this.strings.Add(key, (value, comment));
 		return this;
 	}
 
@@ -39,14 +46,23 @@ public override SourceText GetText(CancellationToken cancellationToken = default
 """);
 		foreach (var pair in this.strings)
 		{
-			sb.AppendLine($"<data name=\"{pair.Key}\" xml:space=\"preserve\">");
-			sb.AppendLine($"<value>{pair.Value}</value>");
+			sb.AppendLine($"<data name=\"{EscapeXml(pair.Key)}\" xml:space=\"preserve\">");
+			sb.AppendLine($"<value>{EscapeXml(pair.Value.Value)}</value>");
+			if (!string.IsNullOrEmpty(pair.Value.Comment))
+			{
+				sb.AppendLine($"<comment>{EscapeXml(pair.Value.Comment)}</comment>");
+			}
 			sb.AppendLine("</data>");
 		}
 		sb.Append("</root>");
 
 		return SourceText.From(sb.ToString(), Encoding.UTF8);
 	}
+
+	static string EscapeXml(string value)
+	{
+		return SecurityElement.Escape(value) ?? value;
+	}
 }
 /*
  <?xml version="1.0" encoding="utf-8"?>

Shiny.Extensions.Localization.Generator.Tests/Shiny.Extensions.Localization.Generator.Tests.csproj

@@ -23,7 +23,6 @@
         <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.7.0" />
         <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.6" />
         <PackageReference Include="Microsoft.Extensions.Localization" Version="9.0.6" />
-        <PackageReference Include="ResXResourceReader.NetStandard" Version="1.3.0" />
     </ItemGroup>
 
 </Project>

Shiny.Extensions.Localization.Generator/LocalizationSourceGenerator.cs

@@ -118,19 +118,28 @@ bool useInternalAccessor
 			{
 				var resourceKey = dataElement.Attribute("name")?.Value ?? string.Empty;
 				var resourceValue = dataElement.Element("value")?.Value ?? string.Empty;
+				var resourceComment = dataElement.Element("comment")?.Value ?? string.Empty;
 				var propertyName = SafePropertyKey(resourceKey);
 
 				var formatParameters = GetFormatParameters(resourceValue);
 
+				// Use comment if available, otherwise use value as fallback
+				var summaryText = !string.IsNullOrEmpty(resourceComment) 
+					? resourceComment 
+					: resourceValue;
+				
 				if (formatParameters.Any())
 				{
 					// Generate method for format strings
-					var methodName = $"{propertyName}Format";
+					// Avoid double "Format" suffix if property name already ends with Format
+					var methodName = propertyName.EndsWith("Format", StringComparison.Ordinal) 
+						? propertyName 
+						: $"{propertyName}Format";
 					var parameters = string.Join(", ", formatParameters.Select(i => $"object parameter{i}"));
 					var arguments = string.Join(", ", formatParameters.Select(i => $"parameter{i}"));
 
 					sb.AppendLine("\t/// <summary>");
-					sb.AppendLine($"\t/// {EscapeXmlComment(resourceValue)}");
+					sb.AppendLine($"\t/// {EscapeXmlComment(summaryText)}");
 					sb.AppendLine("\t/// </summary>");
 					sb.AppendLine($"\tpublic string {methodName}({parameters})");
 					sb.AppendLine("\t{");
@@ -142,7 +151,7 @@ bool useInternalAccessor
 				{
 					// Generate property for simple strings
 					sb.AppendLine("\t/// <summary>");
-					sb.AppendLine($"\t/// {EscapeXmlComment(resourceValue)}");
+					sb.AppendLine($"\t/// {EscapeXmlComment(summaryText)}");
 					sb.AppendLine("\t/// </summary>");
 					sb.AppendLine($"\tpublic string {propertyName} => this.localizer[\"{resourceKey}\"];");
 				}

version.json

@@ -1,6 +1,6 @@
 {
     "$schema": "https://raw.githubusercontent.com/AArnott/Nerdbank.GitVersioning/master/src/NerdBank.GitVersioning/version.schema.json",
-    "version": "2.0.0-beta.{height}",
+    "version": "2.0.1-beta.{height}",
     "release": {
         "branchName": "v{version}",
         "versionIncrement": "build",