Clang的「您是不是指...」变量名纠错算法的工作原理是什么？

我当前使用的Clang版本为Apple clang version 12.0.5 (clang-1205.0.22.11)，编译C++代码时如果出现变量名拼写错误，Clang会在符合条件时给出修正建议。

示例场景 #

示例错误代码如下：

#include <iostream>

int main() {
    int my_int;
    std::cout << my_it << std::endl;
}

对应的编译报错提示为：

spellcheck-test.cpp:5:18: error: use of undeclared identifier 'my_it'; did you mean 'my_int'?
    std::cout << my_it << std::endl;
                 ^~~~~
                 my_int
spellcheck-test.cpp:4:9: note: 'my_int' declared here
    int my_int;
        ^
1 error generated.

Clang判定是否给出变量名纠错建议的标准是什么？

核心判定规则 #

经过实际测试，Clang的纠错判定逻辑包含以下几个核心规则：

• 仅存在唯一的相似候选变量时才会给出建议：如果同时存在多个名称相近的候选（比如代码中同时定义了int my_in;），则不会输出纠错提示。
• 候选变量类型必须适配当前操作场景：如果错误拼写的变量被调用了对应类型不支持的操作，比如代码写的是my_it.size()，而候选的my_int是int类型不支持size()方法，就不会给出建议。
• 变量名相似度需要满足阈值要求：相似度计算支持字符插入、删除两类错误的匹配，变量名长度越长，允许的插入/删除字符数阈值越高，只有满足相似度阈值的名称才会被判定为候选修正项。

内容的提问来源于stack exchange，提问作者Mees de Vries