有没有一种编程方法来识别 C# 保留字？

Question

我正在寻找一个功能，就像

public bool IsAReservedWord(string TestWord)

我知道我可以通过从 MSDN 获取保留字列表来推出自己的功能。不过，我希望语言或 .NET 反射中内置了一些可以依赖的东西，这样当我迁移到较新版本的 C#/.NET 时就不必重新访问该函数。

我寻找这个的原因是我正在寻找 .tt 文件代码生成的保护措施。

Answer 1

CSharpCodeProvider cs = new CSharpCodeProvider();
var test = cs.IsValidIdentifier("new"); // returns false
var test2 = cs.IsValidIdentifier("new1"); // returns true

Answer 2

Microsoft.CSharp.CSharpCodeGenerator 有一个 IsKeyword(string) 方法来完成此任务。但是，该类是内部类，因此您必须使用反射来访问它，并且不能保证它在 .NET 框架的未来版本中可用。请注意，IsKeyword 不考虑不同版本的 C#。

公共方法 System.CodeDom.Compiler.ICodeGenerator.IsValidIdentifier(string) 也拒绝关键字。缺点是此方法还执行一些其他验证，因此其他非关键字字符串也会被拒绝。

更新：如果您只需要生成有效的标识符而不是确定特定字符串是否为关键字，则可以使用 ICodeGenerator.CreateValidIdentifier(string)。 此方法还可以通过在字符串前面添加一个下划线来处理带有两个前导下划线的字符串。对于关键字也是如此。请注意，ICodeGenerator.CreateEscapedIdentifier(string) 在此类字符串前添加了 @ 符号。

以两个前导下划线开头的标识符是为实现（即 C# 编译器和关联的代码生成器等）保留的，因此在代码中避免使用此类标识符通常是一个好主意。

更新 2： 更喜欢 ICodeGenerator.CreateValidIdentifier 而不是 ICodeGenerator.CreateEscapedIdentifier 的原因是 __x 和 @ __x 本质上是相同的标识符。以下内容将无法编译：

int __x = 10;
int @__x = 20;

如果编译器生成并使用 __x 标识符，并且用户将使用 @__x 作为调用 的结果CreateEscapedIdentifier，会出现编译错误。使用 CreateValidIdentifier 可以防止这种情况，因为自定义标识符会变成 ___x（三个下划线）。

Answer 3

但是，我希望语言或 .NET 反射中内置了一些可以依赖的东西，这样当我迁移到较新版本的 C#/.NET 时，我就不必重新访问该函数。

请注意，自 v1.0 以来，C# 从未添加过新的 reserved 关键字。每个新关键字都是未保留的上下文关键字。

尽管我们将来当然有可能添加新的保留关键字，但我们已尽力避免这样做。

有关 C# 5 之前的所有保留关键字和上下文关键字的列表，请参阅

http://ericlippert.com/2009/05/11/reserved-and-contextual-keywords/

Answer 4

    static System.CodeDom.Compiler.CodeDomProvider CSprovider = 
           Microsoft.CSharp.CSharpCodeProvider.CreateProvider("C#");

    public static string QuoteName(string name)
    {
        return CSprovider.CreateEscapedIdentifier(name);
    }

    public static bool IsAReservedWord(string TestWord)
    {
        return QuoteName(TestWord) != TestWord;
    }

由于CreateEscapedIdentifier的定义是：

public string CreateEscapedIdentifier(string name)
{
    if (!IsKeyword(name) && !IsPrefixTwoUnderscore(name))
    {
        return name;
    }
    return ("@" + name);
}

它将正确地将__标识符识别为保留。