Xcode 自定义文件头部注释说明

背景

默认头部注释

不知道你有没有在使用 Xcode 创建文件时觉得文件头部的注释说明不想要或者不是自己喜欢的样式,如果你有这个痛点,那就继续阅读下去哈,本文将让你自定义文件头部注释说明,告别每次创建文件都手动修改注释的痛。
说明: 这是 Xcode9 的一个新特性之一

步骤说明

Xcode9(目前是beta)的发布,让开发者可以自定义文本宏。步骤也是极其简单。

  1. 创建文件名为: IDETemplateMacros.plist 的文件;
  2. 给文件添加你想自定义的宏名称,如: GITHUB
  3. 给自定义的宏填上对应的值,如:https://www.github.com/linshaolie
  4. 保存文件
  5. 将文件放置到特定的目录下(下面会详细介绍)

实践操作

按照上面的步骤进行操作:
首先,创建文件

创建文件

其次,添加宏名称

添加宏

这里, FILEHEADER 宏就是所有新建文件头部的注释说明。是的,通过覆盖这个宏,你就能做到头部信息的自定义了。你也可以通过这个文件创建其他自定义的宏。

接着,添加内容


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

添加内容

几点说明:

  • 通过三个下横线(_),你可以引用内置的一些宏,如:
___DATE___

会获取当前时间

  • 在编辑 plist文件的时候,你会发现按回车键(enter)时,就直接确认了。你需要 按 option + enter 来换行。当然,你也可以通过 Source Code 的方式打开文件编辑
  • 从上面我写的内容上可以看到,在第一行只是做了个换行的操作,是的,Xcode 默认会在第一行前面加上 // ,有点奇葩的设计哈。
  • FILEHEADER 的默认值是:
//  ___FILENAME___
//  ___PACKAGENAME___
//
//  Created by ___FULLUSERNAME___ on ___DATE___.
//  ___COPYRIGHT___
//

然后,将文件拷贝到指定的目录

拷贝文件

最后,创建文件测试下

创建文件

指定的目录

通过将 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 所有创建的文件都有影响
    ~/Library/Developer/Xcode/UserData/IDETemplateMacros.plist

Q & A

:你是怎么知道 FILEHEADER 这个宏就是头部注释说明的?
:在 Xcode Help 上有个对应文件对内置宏进行了说明

内置宏

:能否对宏进行额外操作呢,如:FILENAME 不想要后缀?
:可以。你可以在宏的后面通过冒号(:)进行连接,后面添加修饰语来对宏进行操作,修饰语见这里

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,198评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,663评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,985评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,673评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,994评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,399评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,717评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,407评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,112评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,371评论 2 241
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,891评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,255评论 2 250
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,881评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,010评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,764评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,412评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,299评论 2 260

推荐阅读更多精彩内容