今是昨非

背景#

最近、Xcode のプロジェクト作成時のデフォルトテキストを変更する必要があります。具体的には、毎回作成される上部のデフォルトのコメント説明です。以前にRaywenderlich（現在は Kodeco）のウェブサイトからダウンロードしたコードを見たとき、既存のファイルごとにカスタムの説明が長く記載されていることに気づきました。また、新しいファイルを作成する際にも同じカスタムの説明が含まれていました。疑問はありましたが、詳しく調査することはありませんでした。今日は、実装方法を調査します。

Kodeco のファイルには、次のようなカスタムの説明があります：

実装方法#

Customize text macrosとText macros referenceを参考にすると、Xcode のデフォルトのヘッダーテキストコメントは次のように定義されています：

//  ___FILENAME___
//  ___PACKAGENAME___
//
//  Created by ___FULLUSERNAME___ on ___DATE___.
//  ___COPYRIGHT___
//

そして、Customizing the file header comment and other text macros in Xcode 9を参考にすると、変更手順は次のとおりです：

1. IDETemplateMacros.plistを作成する
2. Rootに対応するtypeをDictionaryに追加または変更する
3. Text macros referenceで説明されているフィールドの意味に従って、対応するキー（フィールド名）と値（定義するテキスト）を追加する

手順は難しくありませんが、IDETemplateMacros.plistファイルの配置場所に注意する必要があります。Customizing the file header comment and other text macros in 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 のカスタム説明の場合、複数の人が参加するワークスペース全体に適用する必要があります。また、プロジェクトごとに作成者の名前を変更したいが、コンピュータのユーザー名を変更したくない（リスクがあるかもしれない）場合は、最後の方法を使用して次のように変更できます：

参考#

• Customizing the file header comment and other text macros in Xcode 9
• Customize text macros
• Text macros reference