有没有办法折叠/折叠Visual Studio代码中的Rust文档注释？

2023年12月23日 419次阅读

在VSCode中,有没有办法折叠/折叠Rust文档注释(即以：//！和///开头的换行注释)？
Swift有类似的评论,因此任何与Swift有关的答案也可能与Rust有关.

如果VSCode中不支持此功能,是否有任何扩展可以实现相同的功能？

最佳答案 我也很担心,所以我环顾四周.令人惊讶的是,自2018年3月以来,由于新的
folding provider API,可以实现这一目标.

我做了一点POC(代码很糟糕,不安全,不打算按原样使用)：

class CommentProvider implements vscode.FoldingRangeProvider {
    // This method must return a list of the foldable ranges
    provideFoldingRanges(document: vscode.TextDocument, context: vscode.FoldingContext, token: vscode.CancellationToken): vscode.ProviderResult<vscode.FoldingRange[]> {
        let ret: vscode.FoldingRange[] = [];
        for (let i = 0; i < document.lineCount; ++i) {
            let line = document.lineAt(i).text.trim();
            if (line.startsWith("//!")) {
                let from = i;
                do {
                    ++i;
                } while (document.lineAt(i).text.trim().startsWith("//!"));
                ret.push(new vscode.FoldingRange(from, i - 1));
            }
        }
        return ret;
    }
}

export function activate(context: vscode.ExtensionContext) {
    let sel: vscode.DocumentSelector = { scheme: 'file', language: 'rust' };
    let pro = new CommentProvider();
    vscode.languages.registerFoldingRangeProvider(sel, pro);
}

它必须在package.json中正确注册：

"activationEvents": [
    "onLanguage:rust"
],
"contributes": {
    "languages": [
        {
            "id": "rust",
            "aliases": [
                "rs"
            ],
            "extensions": [
                "rs"
            ],
            "configuration": "./language-configuration.json"
        }
    ]
},

不过,我不确定这些价值观.

最好的方法是要求团队进行正式的防锈扩展以整合它.

点赞