如何为C# Source Generator诊断设置自定义帮助链接？

你的核心问题是DiagnosticDescriptor构造函数的参数传递错误，导致helpLinkUri没有被正确赋值，VS自然会跳转到默认的帮助页面。此外还有几个需要注意的点，具体如下：

1. 修正构造函数参数赋值 #

DiagnosticDescriptor的构造函数中，helpLinkUri是可选参数，位于description之后，且必须显式指定参数名（如果跳过前面的可选参数）。你的代码中错误地将helpLinkUri参数放在了category的位置，导致实际赋值给了category字段，而非helpLinkUri。

正确的代码示例：

private static void ErrorMessage(SourceProductionContext _arg1, AttributeSourceWithContext _arg2)
{
    DiagnosticDescriptor errorType = new DiagnosticDescriptor(
        id: "Error1",
        title: "Incorrect line",
        messageFormat: "This is complex, open help link for good explanation",
        category: "YourGeneratorCategory", // 必须指定category参数
        defaultSeverity: DiagnosticSeverity.Warning,
        isEnabledByDefault: true,
        helpLinkUri: "https://www.google.com"); // 放在正确的位置，带完整协议头

    Diagnostic errorInstance = Diagnostic.Create(errorType, _arg2.GetLocation());
    _arg1.ReportDiagnostic(errorInstance);
}

2. 必须使用完整的绝对URL #

helpLinkUri必须是带http://或https://的完整绝对路径，不能使用google.com或www.google.com这类不带协议的地址，否则VS无法识别为有效链接，仍会跳转至默认页面。

3. 检查Visual Studio设置 #

确保VS允许跳转到外部链接：

• 打开「工具」→「选项」→「环境」→「帮助」
• 确认「使用外部浏览器打开帮助内容」选项已勾选，或内部浏览器未限制外部链接访问

4. Visual Studio版本兼容性 #

确保使用Visual Studio 2022 17.0及以上版本，旧版本对Source Generator的诊断帮助链接支持不完善，可能存在跳转异常。

内容的提问来源于stack exchange，提问作者user3797758