背景#
最近、Xcode のプロジェクト作成時のデフォルトテキストを変更する必要があります。具体的には、毎回作成される上部のデフォルトのコメント説明です。以前に元の Raywenderlich(現在は Kodeco)のウェブサイトからダウンロードしたコードを見たとき、既存の各ファイルにはカスタムの説明が長く含まれており、新しいファイルを作成する際にも同じカスタムの説明が含まれていることに気付きましたが、疑問に思いましたが、詳しく調査はしていませんでした。今日はその実現方法を調査します:
Kodeco のファイルには、次のようなカスタムの説明があります:
実装#
テキストマクロのカスタマイズとテキストマクロの参照を通じて、Xcode のデフォルトのヘッダーテキストコメントが次のように定義されていることがわかります:
// ___FILENAME___
// ___PACKAGENAME___
//
// Created by ___FULLUSERNAME___ on ___DATE___.
// ___COPYRIGHT___
//
そして、Xcode 9 でのファイルヘッダーコメントと他のテキストマクロのカスタマイズを参考にすると、次の手順で変更できることがわかります:
IDETemplateMacros.plist
を作成するRoot
に対応するtype
をDictionary
に追加または変更する- テキストマクロの参照でフィールドの意味を確認し、対応するキー(フィールド名)と値(定義するテキスト)を追加する
手順は難しくありませんが、IDETemplateMacros.plist
ファイルの配置場所に注意する必要があります。Xcode 9 でのファイルヘッダーコメントと他のテキストマクロのカスタマイズを参考にしてください。
- 個人開発の場合、プロジェクトごとに有効にする場合は、次の場所に配置します:
<ProjectName>.xcodeproj/xcuserdata/[username].xcuserdatad/IDETemplateMacros.plist
- 複数人でプロジェクトごとに有効にする場合は、次の場所に配置します:
<ProjectName>.xcodeproj/xcshareddata/IDETemplateMacros.plist
- 個人開発で全てのワークスペースに有効にする場合は、次の場所に配置します:
<WorkspaceName>.xcworkspace/xcuserdata/[username].xcuserdatad/IDETemplateMacros.plist
- 複数人で全てのワークスペースに有効にする場合は、次の場所に配置します:
<WorkspaceName>.xcworkspace/xcshareddata/IDETemplateMacros.plist
- コンピュータ上のすべてのプロジェクトに有効にする場合は、次の場所に配置します:
~/Library/Developer/Xcode/UserData/IDETemplateMacros.plist
具体的な配置場所は、実際の使用シナリオに基づいて決定します。たとえば、Kodeco のファイルのカスタム説明の場合、複数人で全てのワークスペースに適用する必要があります。また、プロジェクトごとに作成者の名前を変更したいが、コンピュータのユーザー名を変更したくない場合(リスクがあるかもしれません)、最後の方法を使用して変更できます。以下のようになります: