【iOS 小技巧】Xcode自定义文件头部注释

前言

Xcode 在创建文件时，会默认生成 头部注释，不过这些基础的注释往往不能满足我们的需求，而一个文件一个文件去改，那可不是我们攻城狮改做的事🙂。

接下来，我们将利用 Xcode 9的新特性：自定义文本宏，修改默认的注释格式。

Let's do it !

系统默认注释与自定义注释对比

系统默认注释格式：

//
//  AppDelegate.m
//  KLFoundationFrame
//
//  Created by CoderKLLee on 2018/1/16.
//  Copyright © 2018年 Ferryman. All rights reserved.
//

目标注释格式：

//
/*******************************************************************************
        
        File name:     AppDelegate.m
        Author:        Ferryman (李凯隆)
        Blog  :        https://coderkllee.github.io
        E-mail:        coderkllee@163.com
        
        Description:
        
        History:
                2018/1/16: File created.
        
********************************************************************************/

操作步骤

创建 .plist 文件
添加宏名称 FILEHEADER
添加宏对应的值，即自定义的注释格式
将 .plist 文件放置到特定的目录

创建文件

打开项目文件使用快捷键 Command + N 创建 Property List 文件，将其命名为：IDETemplateMacros.plist，请注意 文件名不可使用其他命名!!!

添加宏名称

点击 IDETemplateMacros.plist 文件，添加宏名称 FILEHEADER

添加宏对应的值

右键点击 IDETemplateMacros.plist 文件，使用 Source Code 的方式打开

在 Source Code 模式下添加自定义的注释格式

code 如下

		<key>FILEHEADER</key>
	<string>
/*******************************************************************************
        
        File name:     ___FILENAME___
        Author:        Ferryman (李凯隆)
        Blog  :        https://coderkllee.github.io
        E-mail:        coderkllee@163.com
        
        Description:
        
        History:
                ___DATE___: File created.
        
********************************************************************************/
</string>

系统 内置宏 ：

___DATE___ ：当前系统日期
___FILENAME___ ：当前文件名
___COPYRIGHT___ : 版权
___PACKAGENAME___ ：当前项目工程名
___FULLUSERNAME___ ：当前电脑的管理员名称

将 IDETemplateMacros.plist 放置生效目录

生效目录为：<ProjectName>.xcodeproj/xcuserdata/[username].xcuserdatad/IDETemplateMacros.plist

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

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

大功告成
创建新文件，效果如下：

Q & A

Q ：你是怎么知道 FILEHEADER 这个宏就是头部注释说明的？

A ：在 Xcode Help 上有个文档对内置宏进行了说明。

哥们，都浪到这了，顺手点个赞❤️呗~