如何在Xcode中使标题注释保持最新

时间:2011-10-17 08:56:51

标签: objective-c xcode cocoa comments

Xcode习惯将各种(冗余)信息放在它创建的每个代码文件的顶部,包含版权声明,类名,项目名称和客户端名称。无论喜欢与否,一旦你创建了一个新的类“A”,然后将其重构为“B”,信息就已经错了。评论将继续说这是“A.h”或“A.m”。此外,如果您在下一个项目中重用一个项目中的类,它也会说明错误的项目名称。

//
//  A.h
//  ProjectName
//
//  Created by Author on 19-06-11.
//  Copyright 2011 CompanyName. All rights reserved.
//

必须有一个原因,没有多少人抱怨这个。你有什么方法可以保持标题评论的最新状态?有没有一个工具可以自动纠正它?有隐藏的设置吗?

干杯, EP。

3 个答案:

答案 0 :(得分:11)

可能有一种方法可以更新您的评论,但这会很棘手。

就定制模板而言,这并不是那么糟糕。它只是一个位于的文本文件 /Developer/Platforms/iPhoneOS.platform/Developer/Library/Xcode/Templates/File Templates/Cocoa Touch/

不要在此处编辑文件,更新或重新安装xcode时会被覆盖。 将自定义模板放在主目录中。

~/Library/Developer/Xcode/Templates/File Templates/

High Order Bit explains further

答案 1 :(得分:4)

简答:使用SCM提交挂钩(git examplesvn examplecvs example

原因:嗯,您可以放心,XCode不会这样做。 XCode可以做的是将自己附加到版本控制系统。使用大多数SCM支持的提交挂钩非常简单。它们在提交/推送之前/之后启动,以便更新源代码。您甚至可以在提交等时发送自动电子邮件。

由于GIT是我认为最受欢迎的,所以请参阅this article

答案 2 :(得分:0)

我使用自定义模板(请参阅@TMB的评论以获取解释创建自己的链接),以消除项目名称和版权信息。文件名变化很少,以至于我还没有打扰过我。如果它成了问题,我会从模板中删除它。如果我再次这样做,我会从一开始就消除文件行:有更好更可靠的方法来确定你所处的文件而不是文件的顶部。