Xcode 自定义文件头部注释

如何自定义文件头部注释,想必有很多人知道,就是通过更改Xcode安装包特定目录下的配置来实现,不过这样会有一个弊端,因为工作的时候我不想把太多的个人信息保留在公司的文件上,然而牵一发而动全身,若通过这种方式更改的话,那以后凡是用该Xcode新建文件都会影响到(当然你也可以安装多个Xcode的来避免出现该问题)。好消息是现在Xcode 9 可以直接让开发者自定义文本宏,而且还可以设置生效范围。

Xcode 9 自定义文本宏

基本步骤

  1. 创建一个名为IDETemplateMacros.plist的plist文件
  2. 在该plist文件里添加一个键为FILEHEADER,值为特定字符串(注释格式字符串,下面会说明)

  3. 将该plist文件放置特定的目录下(下面有说明),通过特定的目录来实现不同的生效范围

特定字符串说明

类似于___FILENAME___这种字符串,是通过前后添加三个下划线_,就可以引用内置的一些宏,有关宏的介绍在这里,系统默认的注释样式等价于下面这个plist文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<?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___
// ___PACKAGENAME___
//
// Created by ___FULLUSERNAME___ on ___DATE___.
//
// ___COPYRIGHT___
//
</string>
</dict>
</plist>

点击这里可以下载上述IDETemplateMacros.plist文件,通过修改该文件可以实现自定义的效果

特定的目录

通过将 IDETemplateMacros.plist 文件放置到不同的目录,其影响的范围也不同

工程项目 - 单用户

只对当前 Project 指定的用户(username)有影响

<ProjectName>.xcodeproj/xcuserdata/[username].xcuserdatad/IDETemplateMacros.plist

工程项目 - 多用户

对当前 Project 的所有成员有影响

<ProjectName>.xcodeproj/xcshareddata/IDETemplateMacros.plist

工作区 - 单用户

对指定用户的 Workspace 下的 Project 有影响

<WorkspaceName>.xcworkspace/xcuserdata/[username].xcuserdatad/IDETemplateMacros.plist

工作区 - 多用户

对所有成员 Workspace 下的 Project 有影响

<WorkspaceName>.xcworkspace/xcshareddata/IDETemplateMacros.plist

Xcode全局设置

对 Xcode 所有创建的文件都有影响

~/Library/Developer/Xcode/UserData/IDETemplateMacros.plist

参考链接

Jackson wechat
欢迎您扫一扫上面的微信公众号,订阅我的博客!
如果你觉得我的文章还不错,欢迎打赏~