XPerf
指南

XPerf 文档

XPerf 伞形(多工具包系列)的共享文档。各语言的指南和 Lint 文档存放在各自的包下。

GitHub Pages 会渲染此目录及每个工具包的指南。使用 bash scripts/build-pages.sh serve 进行预览。参见 release.md。

共享文档(本目录)

文档目的
branding.md显示名称 XPerf 与路径 xperf
doc-style.md由 scripts/doc-check.sh 执行的 Markdown 规范
release.md我们在 v* 标签上发布的内容
overview.mdXPerf 是什么:工具架构、共享循环、证据规则
playbook.md操作循环:库存 → 证据 → 语料库 → 反向优化 → 内部测试 → 文档
kits.md检查入口点、默认值、语料库准备笔记(仅限短标签)
quickstart.md每种语言的构建/运行命令
smell-catalog.md跨语言气味指数(ID为每套工具的标识符)
rule-regression.md正/负夹具 + 证据覆盖;诚实的缺口
rule-id-map.md历史数字 → 标识符映射(命令行接口不接受数字)
roadmap-next.md以相同方法进行下一项工作
static-check-sources.md论坛、博客和 GitHub 上 linter 可以检测到的形状的来源

各 package 入口

工具包指南语料/证据政策Lint 文档
zperfzig-performance-guide.mdevidence-policy.md · packages/zperf/evidence/zperf-lint/README
cperfc-performance-guide.mdcorpus.md · evidence-policy.mdpackages/cperf/cperf-lint/
jsperfjs-performance-guide.mdcorpus.md · evidence-policy.mdpackages/jsperf/jsperf-lint/
jvmperfen/corpus.md · evidence-policy.mdpackages/jvmperf/jvmperf-lint/
goperfgo-performance-guide.mdcorpus.md · evidence-policy.mdpackages/goperf/goperf-lint/
pyperfpython-performance-guide.mdcorpus.md · evidence-policy.mdpackages/pyperf/pyperf-lint/
swiftperfswift-performance-guide.mdcorpus.md · evidence-policy.mdpackages/swiftperf/swiftperf-lint/
arktsperfarkts-performance-guide.mdcorpus.md · evidence-policy.mdpackages/arktsperf/arktsperf-lint/
cppperfcpp-performance-guide.mdcorpus.md · evidence-policy.mdpackages/cppperf/cppperf-lint/
csharpperfcsharp-performance-guide.mdcorpus.md · evidence-policy.mdpackages/csharpperf/csharpperf-lint/
phpperfphp-performance-guide.mdcorpus.md · evidence-policy.mdpackages/phpperf/phpperf-lint/
rubyperfruby-performance-guide.mdcorpus.md · evidence-policy.mdpackages/rubyperf/rubyperf-lint/
rustperfrust-performance-guide.mdcorpus.md · evidence-policy.mdpackages/rustperf/rustperf-lint/
kotlinperfkotlin-performance-guide.mdcorpus.md · evidence-policy.mdpackages/kotlinperf/kotlinperf-lint/
objcperfobjc-performance-guide.mdcorpus.md · evidence-policy.mdpackages/objcperf/objcperf-lint/
dartperfdart-performance-guide.mdcorpus.md · evidence-policy.mdpackages/dartperf/dartperf-lint/
luaperflua-performance-guide.mdcorpus.md · evidence-policy.mdpackages/luaperf/luaperf-lint/
beamperfbeam-performance-guide.mdcorpus.md · evidence-policy.mdpackages/beamperf/beamperf-lint/
nimperfnim-performance-guide.mdcorpus.md · evidence-policy.mdpackages/nimperf/nimperf-lint/

导航示意