How to keep the header comments up to date in Xcod

问题:

Xcode has a habit of putting all kinds of (redundant) information at the top of each code file it creates, containing copyright notices, class names, project names and client names. Like it or not, once you create a new class "A", then refactor it to be called "B", the information is wrong already. The comments will keep saying that this is "A.h" or "A.m". In addition, if you reuse classes from one project in a next, it will also state the wrong project name.

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

There must be a reason there aren't many people complaining about this. What is your trick to keep the header comments up to date? Is there a tool that auto-corrects it all? Is there a hidden setting?

Cheers, EP.

回答1:

There may be a way to update your comments but it will be tricky.

As far a customizing the template, this is not as bad. it is just a text file located in /Developer/Platforms/iPhoneOS.platform/Developer/Library/Xcode/Templates/File Templates/Cocoa Touch/

Don't edit the files here, they will get overwritten when you update, or reinstall xcode. Place your custom templates here, in your home directory.

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

High Order Bit explains further.

回答2:

Short Answer: Use SCM Commit Hooks (git example, svn example, cvs example)

Reason: Well, you can be rest assured that XCode will not do it. What XCode can do is attach itself to version control system. Its fairly simple to do using commit hooks that most SCMs support. They fire up before/after the commit/push so that source code is updated. You can even send automated emails when commiting etc.

Since GIT is the most popular one in my opinion these days, see this article.

回答3:

I use custom templates (see @TMB's comment for a link explaining creating your own) that eliminate the project name and copyright info. File name changes rarely enough that that hasn't bothered me yet. If it became a problem, I would just eliminate it from my templates. If I did it again, I would eliminate the file line from the start: There are better and more reliable ways to figure out what file you're in than going to the top of the file.