Back to Details

xcdocs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

XCDocs

XCDocs

Use 
xcdocs
as a local Apple-framework reference while changing code.
在修改代码时，可将
xcdocs
作为本地Apple框架参考工具使用。

Use It During Implementation

代码实现阶段的使用方法

  • Ensure 
    xcdocs
    is available before relying on the skill.
  • Reach for it when an Apple API is unfamiliar, newly released, renamed, or failing to compile.
  • Start with 
    search --json --omit-content
    to find the likely symbol, article, or topic.
  • Add repeatable 
    --framework
    and 
    --kind {article|symbol|topic}
    filters when the query is broad.
  • Treat 
    documents[].uri
    from search results as the canonical identifier for 
    get
    .
  • Use 
    get --json
    to inspect the full entry before editing code that depends on it.
  • Apply what you find to the code: fix symbol names, choose the right overload, adjust availability guards, or switch to the documented API.
  • 在依赖本skill之前，确保
    xcdocs
    已可用。
  • 当遇到不熟悉的Apple API、新发布的API、重命名的API，或是编译失败的API时，使用本工具。
  • 先执行
    search --json --omit-content
    命令来查找可能的符号、文章或主题。
  • 当查询范围较广时，添加可重复使用的
    --framework
    和
    --kind {article|symbol|topic}
    过滤器。
  • 将搜索结果中的
    documents[].uri
    作为
    get
    命令的标准标识符。
  • 在编辑依赖该API的代码前，使用
    get --json
    命令查看完整的文档条目。
  • 将查到的内容应用到代码中：修复符号名称、选择正确的重载方法、调整可用性检查，或是切换到文档中推荐的API。

Common Uses

常见使用场景

  • Fix compile failures against Apple frameworks by verifying the actual symbol name and entry point.
  • Explore a newly released framework or feature area before wiring it into code.
  • Check whether an API is a symbol, a broader topic page, or an article with setup guidance.
  • Find adjacent types or concepts after locating one relevant documentation entry.
  • 通过验证实际的符号名称和入口点，修复针对Apple框架的编译失败问题。
  • 在将新发布的框架或功能集成到代码之前，先进行探索。
  • 检查某个API是符号、更宽泛的主题页面，还是包含设置指南的文章。
  • 在找到一个相关的文档条目后，查找相关的类型或概念。

Reference

参考资料

  • Read references/cli.md for command syntax, JSON shapes, and troubleshooting.
  • 如需了解命令语法、JSON结构和故障排除方法，请阅读references/cli.md。