美文网首页
iOS自定义默认的文件头注释

iOS自定义默认的文件头注释

作者: _人非草木_ | 来源:发表于2019-01-16 15:59 被阅读0次

Xcode中创建新文件默认的文件头注释是这样的格式:

//
//  <file_name>
//  <package_name>
//
//  Created by <Author> on <date>.
//  Copyright © <year>年 <organization>. All rights reserved.
//

其中的<file_name>,<package_name>,<Author>,<date>,<year>,<organization>会根据项目配置自动填充。

但是Xcode默认的文件头注释格式可能不符合项目的要求,需要实现定制。
下面就如何定制文件头注释格式进行介绍:

  • 首先在项目工程中创建一个IDETemplateMacros.plist,并在文件中创建一个名称为FILEHEADER,类型为string的key,并将其内容填写为自定义的注释格式,如下图所示:


    IDETemplateMacros.plist文件示例

我填写到value中的自定义文件头注释格式如下

/*
 * ___FILENAME___
 * ___PACKAGENAME___
 * Copyright (c) Hello Technologies Co., Ltd. ____YEAR___. All rights reserves.
 * Description: 
 * Author: ___FULLUSERNAME___
 * Create: ___DATE___
 */
  • 然后将IDETemplateMacros.plist拷贝到项目工程配置目录中,可以实现自动替换xCode默认文件头注释。
    如果是Workspace工程,将IDETemplateMacros.plist拷贝到"XXX.xcworkspace/xcshareddata"目录下,则在整个Workspace中创建新文件,都会自动使用自定义文件头注释。
    如果是Project工程,将IDETemplateMacros.plist拷贝到"XXX.xcodeproj/xcshareddata"目录下,则在整个Project中创建新文件,都会自动使用自定义文件头注释。
    如果将IDETemplateMacros.plist拷贝到"~/Library/Developer/Xcode/UserData"目录下,则Xcode中创建的所有新文件,,都会自动使用自定义文件头注释。

相关文章

网友评论

      本文标题:iOS自定义默认的文件头注释

      本文链接:https://www.haomeiwen.com/subject/pfnpdqtx.html