iOS

[Xcode]ファイル作成時に自動生成されるヘッダーコメントを編集する

Katz

XcodeでSwiftファイルを作成したときに自動生成されるヘッダーコメントがうっとしいので削除する方法を調べたのでまとめる。

IDETemplateMacros.plistとは?

XcodeではIDETemplateMacros.plistを利用してSwiftファイルを作成したときにヘッダーコメントをどのように自動生成するか決めることができるらしい。

XML
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>FILEHEADER</key>
    <string>
//  ___FILENAME___
//  ___TARGETNAME___
//  
//  Created on ___DATE___
//
</string>
</dict>
</plist>

IDETemplateMacros.plistを配置する場所

XcodeはIDETemplateMacros.plistは以下の場所に配置することができる。Xcodeは以下の場所の優先度が高いところのものから利用する仕組みになっている。

優先順位 名称 パス
1 プロジェクト ユーザー データ <ProjectName>.xcodeproj/xcuserdata/username.xcuserdatad/IDETemplateMacros.plist
2 プロジェクト共有データ <ProjectName>.xcodeproj/xcshareddata/IDETemplateMacros.plist
3 ワークスペース ユーザーデータ <WorkspaceName>.xcworkspace/xcuserdata/username.xcuserdatad/IDETemplateMacros.plist
4 ワークスペース共有データ <WorkspaceName>.xcworkspace/xcshareddata/IDETemplateMacros.plist
5 ユーザー Xcode データ /Library/Developer/Xcode/UserData/IDETemplateMacros.plist

IDETemplateMacros.plistを作成して配置してみる

今回は全てのプロジェクト・ワークスペースに配置したいので「ユーザーXcodeデータ」として、以下の内容のIDETemplateMacros.plistをvimで書き込み配置し、ファイル名だけがヘッダーコメントに含められるようにしてみる。

XML
> vi ~/Library/Developer/Xcode/UserData/IDETemplateMacros.plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
  <key>FILEHEADER</key>
  <string>
//  ___FILENAME___
  </string>
</dict>
</plist>
:qw

すると以下のようにヘッダーコメントにファイル名のみが記載されるようになるので問題なく動作している。

参考記事

ABOUT ME
Katz
Katz
Androidエンジニア
AndroidエンジニアをやっているKatzです。最近はKotlin Multiplatformを中心にやっています。経歴やお仕事の依頼については、私のプロフィールに詳細を記載していますので、ご確認ください。
記事URLをコピーしました