Skip to content

Use Remark comments to show example string #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 8, 2025
Merged

Use Remark comments to show example string #16

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
573f956
Use Remark comments to show example string
Jack251970 Mar 8, 2025
e830b88
Improve comment format
Jack251970 Mar 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions Flow.Launcher.Localization.SourceGenerators/Localize/LocalizeSourceGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,22 +446,32 @@ private static void GeneratedHeaderFromPath(StringBuilder sb, string xamlFilePat

private static void GenerateDocComments(StringBuilder sb, LocalizableString ls, string tabString)
{
if (ls.Summary != null)
if (!string.IsNullOrEmpty(ls.Summary))
{
sb.AppendLine($"{tabString}/// <summary>");
foreach (var line in ls.Summary.Split('\n'))
var summaryLines = ls.Summary.Split('\n');
if (summaryLines.Length > 0)
{
sb.AppendLine($"{tabString}/// {line.Trim()}");
sb.AppendLine($"{tabString}/// <summary>");
foreach (var line in summaryLines)
{
sb.AppendLine($"{tabString}/// {line.Trim()}");
}
sb.AppendLine($"{tabString}/// </summary>");
}
sb.AppendLine($"{tabString}/// </summary>");
}

sb.AppendLine($"{tabString}/// <code>");
foreach (var line in ls.Value.Split('\n'))
var lines = ls.Value.Split('\n');
if (lines.Length > 0)
{
sb.AppendLine($"{tabString}/// {line.Trim()}");
sb.AppendLine($"{tabString}/// <remarks>");
sb.AppendLine($"{tabString}/// e.g.: <code>");
foreach (var line in lines)
{
sb.AppendLine($"{tabString}/// {line.Trim()}");
}
sb.AppendLine($"{tabString}/// </code>");
sb.AppendLine($"{tabString}/// </remarks>");
}
sb.AppendLine($"{tabString}/// </code>");
}

private static void GenerateLocalizationMethod(
Expand Down
Loading