xcdocs

XCDocs

コードを変更する際は、ローカルの Apple フレームワークリファレンスとして xcdocs を使用します。

実装中の使い方

• このスキルに頼る前に、xcdocs が利用可能であることを確認します。
• Apple API の使い方が不明な場合、新しくリリースされた場合、名前が変更された場合、またはコンパイルに失敗する場合に使用します。
• まず search --json --omit-content を実行し、該当しそうなシンボル、記事、トピックを探します。
• クエリの範囲が広い場合は、繰り返し指定できる --framework と --kind {article|symbol|topic} のフィルターを追加します。
• 検索結果の documents[].uri を get に渡す正規の識別子として扱います。
• 依存するコードを編集する前に、get --json を使ってエントリー全体を確認します。
• 調べた内容をコードに反映します。シンボル名を修正し、適切なオーバーロードを選び、利用可能性のガードを調整するか、ドキュメントに記載された API に切り替えます。

よくある用途

• Apple フレームワークでのコンパイルエラーを、実際のシンボル名とエントリーポイントを確認して修正します。
• 新しくリリースされたフレームワークや機能領域を調べてから、コードに組み込みます。
• API がシンボルなのか、より広いトピックページなのか、セットアップ方法を説明した記事なのかを確認します。
• 関連するドキュメントエントリーを見つけた後、隣接する型や概念を探します。

リファレンス

• コマンド構文、JSON の形式、トラブルシューティングについては、references/cli.md をお読みください。