Как поддерживать заголовок комментариев в актуальном состоянии в Xcode

Question

Xcode имеет привычку размещать всевозможную (избыточную) информацию в верхней части каждого создаваемого им файла кода, содержащего уведомления об авторских правах, имена классов, имена проектов и имена клиентов. Нравится вам это или нет, но как только вы создадите новый класс «А», а затем проведете рефакторинг, который будет называться «В», информация уже неверна. В комментариях будет повторяться, что это «A.h» или «A.m». Кроме того, если вы повторно используете классы из одного проекта в следующем, в нем также будет указано неправильное имя проекта.

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

Должна быть причина, по которой не многие жалуются на это. Какой твой трюк, чтобы держать комментарии заголовка в курсе? Есть ли инструмент, который автоматически все исправляет? Есть ли скрытые настройки?

Cheers, EP.

Answer 1

Возможно, есть способ обновить ваши комментарии, но это будет сложно.

Что касается настройки шаблона, это не так плохо.это просто текстовый файл, расположенный в /Developer/Platforms/iPhoneOS.platform/Developer/Library/Xcode/Templates/File Templates/Cocoa Touch/

. Не редактируйте здесь файлы, они будут перезаписаны при обновлении или переустановке xcode.Разместите ваши собственные шаблоны здесь, в вашем домашнем каталоге.

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

Бит старшего разряда объясняет далее .

Answer 2

Краткий ответ: Использование SCM Commit Hooks ( пример git , пример svn , пример cvs )

Причина : Ну, вы можете быть уверены, что XCode не сделает этого. Что может сделать XCode, так это подключиться к системе контроля версий. Это довольно просто сделать, используя хуки коммитов, которые поддерживает большинство SCM. Они запускаются до / после коммита / толчка, так что исходный код обновляется. Вы даже можете отправлять автоматические электронные письма при совершении транзакций и т. Д.

Поскольку GIT является самым популярным на мой взгляд в наши дни, см. эту статью .

Answer 3

Я использую пользовательские шаблоны (см. Комментарий @TMB для ссылки, объясняющей создание собственного), которые исключают название проекта и информацию об авторских правах.Имя файла меняется достаточно редко, что меня это еще не беспокоило.Если бы это стало проблемой, я бы просто исключил ее из своих шаблонов.Если бы я сделал это снова, я бы удалил строку файла с самого начала: есть лучшие и более надежные способы выяснить, в каком файле вы находитесь, чем переходить в начало файла.