swift-api-design-guidelines
SwiftのAPI設計ガイドラインを適用して、SwiftのAPIを命名、ラベル付け、文書化します。引数ラベルルール、可変/非可変ペアの命名パターン、副作用命名、ドキュメントコメント構造、呼び出し箇所での明確さ、ロールベースの命名、プロトコル命名規則、デフォルト引数の活用、大文字小文字表記規則、専門用語を網羅しています。新しいSwiftAPIの設計、命名と引数ラベルのレビュー、ドキュメントコメント作成、呼び出し箇所の明確さのためのリファクタリング時に使用します。
description の原文を見る
Apply Swift API Design Guidelines to name, label, and document Swift APIs. Covers argument label rules (prepositional phrase rule, grammatical phrase rule, first-label omission), mutating/nonmutating pair naming (-ed/-ing participle pattern, form- prefix, sort/sorted, formUnion/union), side-effect naming (noun for pure, verb for mutating), documentation comment structure (summary by declaration kind, O(1) complexity rule), clarity at call site, role-based naming, protocol naming (-able/-ible/-ing), default arguments over method families, casing conventions, and terminology. Use when designing new Swift APIs, reviewing naming and argument labels, writing documentation comments, or refactoring for call site clarity.
SKILL.md 本文
Swift API 設計ガイドライン
型、メソッド、プロパティ、パラメータ、引数ラベルの命名時に Swift API 設計ガイドラインを適用します。Swift 6.3 を対象とします。言語機能と構文については、swift-language を参照してください。並行処理パターンについては、swift-concurrency を参照してください。
目次
引数ラベル規則
引数ラベルは、呼び出し地点がどのように見えるかを決定します。これらの規則を順番に適用してください。
最初の引数ラベルを省略する場合
文法句規則。 最初の引数が基本名と文法句を形成する場合、ラベルを省略します。ラベルになるはずだった先頭の単語を基本名に移動してください。
...
詳細情報
- 作者
- dpearson2699
- ライセンス
- NOASSERTION
- 最終更新
- 不明
Source: https://github.com/dpearson2699/swift-ios-skills / ライセンス: NOASSERTION
関連スキル
doubt-driven-development
重要な判断はすべて、本番環境への展開前に新しい視点から対抗的レビューを実施します。速度より正確性が重要な場合、不慣れなコードを扱う場合、本番環境・セキュリティに関わるロジック・取り消し不可の操作など影響度が高い場合、または後でバグを修正するよりも今検証する方が効率的な場合に活用してください。
apprun-skills
TypeScriptを使用したAppRunアプリケーションのMVU設計に関する総合的なガイダンスが得られます。コンポーネントパターン、イベントハンドリング、状態管理(非同期ジェネレータを含む)、パラメータと保護機能を備えたルーティング・ナビゲーション、vistestを使用したテストに対応しています。AppRunコンポーネントの設計・レビュー、ルートの配線、状態フローの管理、AppRunテストの作成時に活用してください。
desloppify
コードベースのヘルスチェックと技術負債の追跡ツールです。コード品質、技術負債、デッドコード、大規模ファイル、ゴッドクラス、重複関数、コードスメル、命名規則の問題、インポートサイクル、結合度の問題についてユーザーが質問した場合に使用してください。また、ヘルススコアの確認、次の改善項目の提案、クリーンアップ計画の作成をリクエストされた際にも対応します。29言語に対応しています。
debugging-and-error-recovery
テストが失敗したり、ビルドが壊れたり、動作が期待と異なったり、予期しないエラーが発生したりした場合に、体系的な根本原因デバッグをガイドします。推測ではなく、根本原因を見つけて修正するための体系的なアプローチが必要な場合に使用してください。
test-driven-development
テスト駆動開発により実装を進めます。ロジックの実装、バグの修正、動作の変更など、あらゆる場面で活用できます。コードが正常に動作することを証明する必要がある場合、バグ報告を受けた場合、既存機能を修正する予定がある場合に使用してください。
incremental-implementation
変更を段階的に実施します。複数のファイルに影響する機能や変更を実装する場合に使用してください。大量のコードを一度に書こうとしている場合や、タスクが一度では完結できないほど大きい場合に活用します。