LoginSignup
1
3

More than 3 years have passed since last update.

【iOS】Swiftファイルのヘッダーコメントをカスタマイズする

Last updated at Posted at 2019-12-30

概要

iOSの開発をする際にXcodeでファイルを追加すると、ファイルのヘッダーに以下のようなコメントが入るかと思います。

Sample.swift
//
//  Sample.swift
//  SampleProject
//  
//  Created by ~~~ on 2020/12/30
//  Copyright © 2020 ~~~. All rights reserved.
//

複数人で開発をする際に、上記コメントを合わせたかったので、コメントをカスタマイズする方法についてまとめてみました。

環境

Xcode: 11.2.1
Swift: Swift5

手順1

「IDETemplateMacros.plist」を生成します。
(生成したファイルの配置場所は手順3で説明します)

手順2

手順1で生成したファイルに以下を追加します。
(サンプルでは作成者・作成元を非表示としました)

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___
//  ___TARGETNAME___
//</string>
</dict>
</plist>

手順3

出来上がった「IDETemplateMacros.plist」をプロジェクトに追加します。
今回は複数人で開発することを想定し、Gitの管理下となるよう以下のディレクトリにファイルを追加しました。
<ProjectName>.xcodeproj/xcshareddata/IDETemplateMacros.plist
※「/xcshareddata」は「.gitignore」に入れていない前提です!

確認

Xcodeからファイルを追加し、以下のようになっていれば設定完了です。

Sample.swift
//
//  Sample.swift
//  SampleProject
//  

確認

githubに雑なメモも残してあるので、参考までにどうぞ。
https://github.com/hidetomo117/Other_SwiftFileHeaderComment

参考

https://dev.classmethod.jp/etc/ios-xcode%E3%81%AE%E3%83%87%E3%83%95%E3%82%A9%E3%83%AB%E3%83%88%E3%81%AE%E3%83%98%E3%83%83%E3%83%80%E3%83%BC%E3%82%B3%E3%83%A1%E3%83%B3%E3%83%88%E3%81%AE%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC/
https://help.apple.com/xcode/mac/9.0/index.html?localePath=en.lproj#/dev91a7a31fc

1
3
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
3