【iOS 小技巧】Xcode自定義檔案頭部註釋

Bit俠發表於2018-01-29
iOSXCode

前言

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

放置生效目錄

大功告成
建立新檔案，效果如下：

大功告成

Q & A

Q ：你是怎麼知道 FILEHEADER 這個巨集就是頭部註釋說明的？

A ：在 Xcode Help 上有個 文件 對內建巨集進行了說明。

哥們，都浪到這了，順手點個贊❤️唄~

參考文件

相關文章