【Xcode】ヘッダコメントのカスタマイズ

Xcodeで自動生成されるヘッダコメントを任意にカスタマイズする方法を解説します。

デフォルトでは次のようなヘッダコメントが生成されます。

スポンサーリンク

環境

この記事の情報は次のバージョンで動作確認しています。

【Xcode】10.2
【macOS】Mojave バージョン 10.14.5

事前準備

テキストエディタで~/Library/Developer/Xcode/UserData/IDETemplateMacros.plistという名前のファイルを新規に作成します。

ファイルの中身には次のコードをコピペして下さい。

以上で、事前準備は完了です。

置くだけで、このファイルはxcodeで自動生成されるヘッダコメントのテンプレートとして機能します。

上で示したコードは、デフォルトのヘッダコメントと全く同じものが生成されるテンプレートですので、これだけでは変化はありませんが、このテンプレートを変更する事により、ヘッダコメントをカスタマイズでるようになります。

テンプレートのカスタマイズ

先に示したテンプレートの<String></String>で囲まれた部分が、生成されるヘッダコメントのフォーマットを示しています。

文字列FILENAMEやPROJECTNAMEはテキストマクロを示しており、3つの連続するアンダースコア(_)で囲む事で指定します。

各々のテキストマクロは次のような値を返します。

FILENAME
ファイルのフルネーム

PROJECTNAME
プロジェクト名

USERNAME
現在のmacOSユーザー名

DATE
現在日付

COPYRIGHT
プロジェクトのチームの会社名を使用する著作権文字列。会社名がない場合、文字列は空白。

ここにあげた以外のテキストマクロについては、こちらの公式サイトを参照して下さい。
help.apple.com: Text macros reference

標準のヘッダコメントと比較すると、1行目の”//”が足りないように見えますが、ソースファイルの先頭には必ず入る”//”が入るため、このテンプレートに含める必要はありません。

プロジェクト単位にカスタマイズ

ヘッダコメントのカスタマイズをプロジェクト単位で定義する事も可能です。

これを実現するには、テンプレートファイルをxcodeのプロジェクトファイル内の下記に配置します。

.xcodeproj/xcshareddata/IDETemplateMacros.plist

テンプレートファイルの配置方法は以下の通りです。

対象のプロジェクトファイルを右クリック、コンテクストメニューの「パッケージの内容を表示」を選択。

画像1:パッケージの内容を表示

プロジェクトファイルのフォルダが展開されるので、新規フォルダ(xcshareddata)を作成。

その下にIDETemplateMacros.plistを配置します。

画像2:パッケージの展開

なお、~/Library/Developer/Xcode/UserData/IDETemplateMacros.plistファイルが同時に存在していた場合は、プロジェクトファイル内テンプレートが優先されます。

最後に

標準のヘッダーコメントがいまいち気に入らないという方は、この方法でカスタマイズして見て下さい。

コメント