官网主题覆盖对照表¶
本页用于跟踪中文文档与 JetBrains 官方 IntelliJ Platform Plugin SDK 文档的对应关系。它不是完整翻译目录,而是维护检查表:每次补文档时都应更新覆盖状态、来源和缺口。
最后核对日期:2026-06-18。
已覆盖主题¶
| 官方主题 | 中文章节 | 覆盖状态 |
|---|---|---|
| IntelliJ Platform Plugin SDK 首页与总体概念 | 平台与插件开发概览 | 已覆盖主线 |
| Creating a Plugin Gradle Project | 创建与运行插件项目 | 已覆盖主线 |
| IntelliJ Platform Gradle Plugin 2.x | 创建与运行插件项目、Gradle 构建系统 | 已覆盖主线、仓库、依赖、多模块和发布任务 |
| Plugin Configuration File | plugin.xml 配置文件 | 已覆盖常用元素 |
| Actions | Action | 已覆盖基础和线程选择 |
| Services | Service | 已覆盖 Application/Project Service 与 Light Service |
| PSI | PSI | 已覆盖基础模型与读写动作 |
| Code Completion / Code Inspections | 编辑器能力 | 已覆盖基础实现 |
| Threading Model | 线程模型 | 已覆盖读写动作、EDT/BGT、后台任务 |
| Testing Plugins | 插件测试、测试与 CI | 已覆盖测试思路、fixture、light/heavy、testdata、highlighting 和 CI |
| Publishing Plugin | 构建与发布 | 已覆盖构建、签名、发布主路径 |
| Tool Windows / Settings / Persisting State | Tool Window 与设置 | 已覆盖常用用法 |
| Custom Language Support | 自定义语言支持 | 已覆盖开发路线 |
| Virtual File System / Indexing and PSI Stubs | VFS 与索引 | 已覆盖核心注意点 |
| Plugin Compatibility / Plugin Dependencies | 兼容与依赖 | 已覆盖模块、插件、可选依赖 |
| Extensions / Extension Points / Listeners | 扩展点与动态插件 | 已覆盖使用、定义和监听器 |
| Dynamic Plugins / Components Deprecated | 扩展点与动态插件 | 已覆盖动态限制和迁移原则 |
| IDE Development Instance | 开发实例与验证 | 已覆盖沙盒、JBR、Auto-Reload |
| Plugin Verifier / Incompatible Changes | 开发实例与验证 | 已覆盖验证方法和 API 状态 |
| UI Components / Informing Users / Dialogs / Status Bar Widgets | UI 与用户体验 | 已覆盖常用 UI 模式 |
| Run Configurations / Execution | 运行配置与执行 | 已覆盖配置、执行、控制台、上下文运行 |
| Project Model / Workspace Model / External System | 项目模型与外部系统 | 已覆盖项目结构、Workspace Model、外部系统导入 |
| File Type / Lexer / Parser / Syntax Highlighting / Annotator / Formatter | 自定义语言实现进阶 | 已覆盖语言实现主干 |
| References / Find Usages / Rename / Safe Delete / Line Marker | 导航与重构 | 已覆盖名称、引用、查找和重构主线 |
| Debugging / XDebugger | 调试器与 XDebugger | 已覆盖架构、依赖和实现检查清单;仍需结合具体语言插件源码深化 |
| VFS Refresh / File Watchers / Gists / Index Performance | VFS 与索引实战 | 已覆盖刷新、事件、Gists、Dumb Mode 和索引性能 |
| Product-specific APIs / multi-IDE compatibility | 产品专属 API | 已覆盖多产品依赖、可选依赖和验证矩阵 |
| Remote Development / Split Mode | Remote Development | 已覆盖前后端拆分、RPC、运行调试和延迟测试 |
| Marketplace / Signing / Plugin Logo / Release Channels | Marketplace 运营发布 | 已覆盖发布、签名、Logo、Token 和渠道 |
| Incompatible Changes / Internal API migration strategy | 版本迁移 | 已覆盖 2025/2026 迁移重点和验证流程 |
| Gradle multi-module / dependency resolution / plugin modules | Gradle 构建系统 | 已覆盖 2.x 构建配置和多模块打包策略 |
| Tests and Fixtures / Light and Heavy Tests / Testing Highlighting | 测试与 CI | 已覆盖官方测试基础设施和常用测试模式 |
| IntelliJ Platform Plugin Template / GitHub Actions | 工程模板与 GitHub Actions | 已覆盖官方模板结构、CI、发布流和本仓库文档 CI |
| Paid Plugins / Monetization / Licensing | 付费插件与许可 | 已覆盖商业模型、许可参数、检查调用和发布流程 |
| Debug protocol adapter / remote debug engineering | 调试协议适配 | 已覆盖协议映射、断点、路径映射、变量树和 Split Mode 注意事项 |
| Kotlin、Java、JavaScript、Python、Database 产品 API | 产品 API 深水区 | 已覆盖能力边界、依赖 ID、测试框架、可选依赖隔离、产品矩阵和降级策略 |
| Marketplace approval / privacy / vendor compliance | Marketplace 商业化进阶 | 已覆盖审核、内容治理、Vendor/trader、隐私披露、企业采购材料、银行信息和税务边界 |
| XDebugger source walkthrough | XDebugger 源码导读 | 已覆盖 XDebugger API、JavaDebugProcess、JavaLineBreakpointType、JavaStackFrame、变量树和 evaluator 的源码阅读路径 |
| Official SDK sitemap audit | 官方目录级审计 | 已解析官方 IntelliJ SDK sitemap 的 402 个页面,并按主题簇标记深入覆盖、合并覆盖、参考覆盖和待专项展开 |
| Inlay Hints / Documentation / Intentions / Live Templates / Postfix Templates | Code Insight 细节专题 | 已覆盖 inlay 选择、Documentation Target API、intention preview、inspection options、live template 和 postfix template |
| UI Guidelines / UI Components / Accessibility / Window Sizes | UI Guidelines 组件落地专题 | 已覆盖平台组件选择、文案、大小写、窗口尺寸、验证错误、空状态、无障碍和 UI QA |
| Integration Tests API / UI Integration Tests | 集成测试专题 | 已覆盖 Starter/Driver、Gradle 配置、真实项目、IDE 异常收集、JMX/RMI API interaction、UI hierarchy、组件查找和 CI 分层 |
| Themes / Theme Structure / Theme Metadata | Theme 插件开发专题 | 已覆盖主题插件结构、themeProvider、theme JSON、UI key、图标、editor scheme、背景图、parentTheme、theme metadata、运行部署和 QA |
| Coroutine scopes / coroutine read actions / background processes | 协程、读动作与后台任务进阶 | 已覆盖 service scope、action scope、dispatcher、coroutine read actions、NBRA 迁移、Progress API、execution contexts、modality 和 coroutine dump |
| JCEF / Embedded Terminal / VCS Integration / Trusted Projects | 平台集成专题 | 已覆盖 JCEF 适用边界、资源释放、JS 通信、Terminal 2025.3 API、VCS ChangeProvider/dirty scope、Trusted Projects 安全模型和 QA |
| Workspace Model entity declaration/read/mutation/events | Workspace Model 深水区 | 已覆盖 entity/storage/source、属性类型、VirtualFileUrl、SymbolicEntityId、parent-child、读取、修改、replaceBySource、eventLog、EntityPointer 和迁移策略 |
后续补强主题¶
本轮目录级审计列出的高/中优先级专项缺口已经补齐。后续仍可继续做低优先级长尾增强:
| 官方主题 | 建议中文章节 | 优先级 |
|---|---|---|
| Spell Checking | 拼写检查专题 | 低 |
| Project Wizard / Facet | 项目向导与 Facet 专题 | 低 |
| Editor events / Document 同步 | 编辑器事件与 Document/VFS 同步专题 | 低 |
维护规则¶
- 新增章节前先查官方页面,确认概念、版本要求和推荐 API。
- 示例代码优先使用 IntelliJ Platform Gradle Plugin 2.x。
- 涉及版本号时标注核对日期,避免把“当前官方示例”写成永久事实。
- 避免逐字翻译官方文档;用中文重新组织,同时保留来源链接。
- 每次新增或调整章节后运行
mkdocs build --strict。
核对来源¶
- IntelliJ Platform Plugin SDK
- IntelliJ Platform Gradle Plugin 2.x
- Plugin Compatibility with IntelliJ Platform Products
- Plugin Dependencies
- Extensions
- Extension Points
- Listeners
- Dynamic Plugins
- IDE Development Instance
- Verifying Plugin Compatibility
- Incompatible Changes in IntelliJ Platform and Plugins API
- User Interface Components
- Informing Users
- Dialogs
- Status Bar Widgets
- Run Configurations
- Execution
- Project Model
- Workspace Model
- External System Integration
- Registering a File Type
- Lexer and Parser Definition
- Implementing Parser and PSI
- Syntax and Error Highlighting
- Code Formatter
- Reference Contributor
- Find Usages
- Rename Refactoring
- Safe Delete Refactoring
- Line Marker Provider
- Virtual File System
- Indexing and PSI Stubs
- Split Mode (Remote Development)
- Publishing a Plugin
- Plugin Signing
- Plugin Logo
- Incompatible Changes 2026
- Incompatible Changes 2025
- Tests and Fixtures
- Light and Heavy Tests
- Test Project and Testdata Directories
- Testing Highlighting
- IntelliJ IDEA Plugin Development
- WebStorm Plugin Development
- DataGrip Plugin Development
- IntelliJ Platform Plugin Template
- Plugin monetization
- Paid plugins
- Required paid plugin parameters
- License verification calls
- Release the plugin
- Best practices for listing your plugin
- Vendor profile
- Developer requirement to disclose trader or non-trader status
- Verified vendor badge
- Report plugin
- JetBrains Marketplace Content Moderation Policy
- Digital Services Act
- Modular Plugins
- XDebugProcess.java
- XBreakpointHandler.java
- XStackFrame.java
- XValue.java
- JavaDebugProcess.java
- JavaLineBreakpointType.java
- JavaStackFrame.java
- IntelliJ Platform Plugin SDK sitemap
- Inlay Hints
- Documentation
- Documentation Provider Tutorial
- Intentions
- Intention Action Preview
- Inspection Options
- Live Templates
- Providing Live Templates
- Live Templates Configuration File
- Postfix Templates
- Advanced Postfix Templates
- UI Guidelines
- User Interface Components
- Accessibility
- Window Sizes
- Writing Short and Clear
- Capitalization
- Validation Errors
- Integration Tests
- Introduction to Integration Tests
- Integration Tests: UI Testing
- Integration Tests: API Interaction
- Testing FAQ
- Getting Started with Themes
- Developing a Theme
- Creating a Theme Project
- Theme Structure
- Customizing Themes - Icons and UI Controls
- Themes - Editor Schemes and Background Images
- Exposing Theme Metadata
- Coroutine Scopes
- Launching Coroutines
- Coroutine Dispatchers
- Coroutine Read Actions
- Background Processes
- Execution Contexts
- Coroutine Dumps
- Embedded Browser (JCEF)
- Embedded Terminal
- Version Control Systems
- Trusted Project
- Entity Declaration
- Entity Properties
- Entity Read
- Entity Mutation
- Event Listening
- Usage Examples