Швидкий: еквівалент # попередження

Чи є у Свіфта еквівалент # попередження? Він просто використовується для показу попередження у власному графічному інтерфейсі Xcode

Мене також цікавить, чи є еквівалент #error.

Apple сказала, що знак #pragma скоро з'явиться, можливо, це може бути те саме.

Надалі Apple Devs може дуже добре випустити //WARNING:орієнтир або надати функціональність для іншого, який названий орієнтиром.

Однак сьогодні, щоб звернути увагу на цю функціональність із Swift у Xcode, ви можете зробити наступне, як описано Бен Додсон та Джефрі Самбеллсом:

Додайте новий сценарій запуску на вкладку Фази збірки вашої цілі (налаштування проекту> Фази збірки> '+'> Нова фаза сценарію запуску) та вставте наступний код у порожнє поле:

TAGS="TODO:|FIXME:"
echo "searching ${SRCROOT} for ${TAGS}"
find "${SRCROOT}" \( -name "*.swift" \) -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($TAGS).*\$" | perl -p -e "s/($TAGS)/ warning: \$1/"

Це змусить Xcode позначити попередження під час компіляції для будь-яких // TODO:або // FIXME:коментарів, які ви розмічаєте.

Крім того, ви можете змінити TAGS за допомогою спеціального тегу: TAGS="WARNING:"у наведеному вище коді, який би зберігав поведінку за замовчуванням для TODO & FIXME і підніме попередження про час компіляції на будь-які коментарі, позначені як // WARNING:.

http://bendodson.com/weblog/2014/10/02/showing-todo-as-warning-in-swift-xcode-project/ http://jeffreysambells.com/2013/01/31/generate-xcode- попередження-від -до-коментарів

РЕДАКТ: 18/11/14

@ david-h підкреслив хороший пункт у своєму коментарі. Якщо ви хочете підняти ці попередження лише в конкретній конфігурації збірки, ви можете зробити наступне:

if [ "${CONFIGURATION}" = "Debug" ]; then
TAGS="TODO:|FIXME:"
echo "searching ${SRCROOT} for ${TAGS}"
find "${SRCROOT}" \( -name "*.swift" \) -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($TAGS).*\$" | perl -p -e "s/($TAGS)/ warning: \$1/"
fi

Крім того, ви можете використовувати "Випуск", а не "Налагодження", щоб орієнтуватися лише на виробничі збірки.

Редагувати

З Swift 4.2 підтримка на рівні мови доступна як для попереджень, так і для помилок побудови.

#warning("Warning description")
#error("Throws a build error")

Оригінальний відповідь

Швидке, брудне та о, настільки вишукано просте все одночасно.

// Description of what you need to fix

var FIX_ME__🛠🛠🛠: AnyObject

Виносить попередження про те, що "FIX_ME__🛠🛠🛠" ніколи не використовувався.

Ви можете додати смайлики до імені змінної, якщо вам подобається ... Я часто використовую 😱 і 🛠, для чого-небудь, що дійсно потребує виправлення, я б навіть вважав 💩. Ви можете замінити FIX_ME__з тим, що ви хочете: ALGORITHM_NEEDS_REVIEW, BugID_148або JOHNNY_YOU_BROKE_THISдеякі приклади.

Швидкий, без налаштувань, стислих та смайликів може навіть додати гумор / особистість у ваш код. Іноді найпростішим рішенням є найкраще рішення.

Опублікувати оновлення WWDC 2018

Починаючи з Xcode 10 та Swift 4.2, тепер ви зможете #warningзнову користуватися таким чином:

#warning("TODO: Clean up this code after testing")

Це відображатиметься як попередження в Xcode так само, як очікувалося!

Це працює навіть у поєднанні з #ifчеками, наприклад, наступне буде показувати попередження, лише якщо ваша цільова платформа - iOS:

#if os(iOS)
    #warning("this code is untested in iOS")
#endif

Є також, #errorякщо ви хочете, щоб ваша збірка вийшла з ладу.

Попередній відповідь WWDC 2018

У Swift за допомогою XCode 6 ви можете використовувати різні види орієнтирів для різних цілей. Ось що Apple говорить про це:

Тепер Xcode підтримує // MARK :, // TODO: і // FIXME: орієнтири для анотування коду та перерахування їх на панелі стрибків.

Тож для встановлення попередження з описом ви б використовували щось подібне:

//TODO: Clean up this code after testing

Якщо ви просто хочете встановити коротку позначку (якщо пригадати, що вам потрібно запам'ятати), скористайтеся цим:

//FIXME

EDIT: Однак ці орієнтири відображаються лише на панелі стрибків XCode, яка може бути не тим, чого ви хочете, і чого можна очікувати, особливо від знаків // TODO: та // FIXME. Я подав радари на те: # 17776817. Сподіваємось, Apple додасть це у наступних складах у XCode 6.

РІШЕННЯ (EDIT 2): Якщо ви встановите Swift Linter через Homebrew (запустіть brew install swiftlintпісля a brew update) та додасте запропонований сценарій збірки до свого проекту, ви побачите, що всі ваші TODOта FIXMEорієнтири відображаються як попередження в Xcode. SwiftLint навіть додасть ще кілька попереджень / помилок, які ви можете налаштувати відповідно до ваших потреб - я можу лише рекомендувати використовувати SwiftLint, і це прекрасно вирішує цю проблему!

Ще не додана командою Apple. Що я вирішив зробити, це, мабуть, обман, але принаймні це показує мені повідомлення FIXME. Отже, що я роблю, це оголосити функцію FIXME () у файлі Swift:

@availability(iOS, deprecated=1.0, message="I'm not deprecated, please ***FIXME**")
func FIXME()
{
}

і коли я закликаю його з будь-якої іншої функції, вона показує попередження, наприклад

override func tableView(tableView: UITableView, numberOfRowsInSection section: Int) -> Int
{
    FIXME()     // Incomplete method implementation.
    return 0
}

Для використання Swift 2

@available(iOS, deprecated=1.0, message="I'm not deprecated, please ***FIXME**")

Подивіться на цю статтю .

Ви можете написати власний сценарій, який висвітлить усі теги.

TAGS="TODO:|FIXME:"
ERRORTAG="ERROR:"
find "${SRCROOT}" \( -name "*.h" -or -name "*.m" -or -name "*.swift" \) -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($TAGS).*\$|($ERRORTAG).*\$" | perl -p -e "s/($TAGS)/ warning: \$1/" | perl -p -e "s/($ERRORTAG)/ error: \$1/"

Це призводить до:

Як альтернатива, якщо ви хочете, щоб щось з’явилося на панелі попереджень, ви можете написати щось на зразок:

if (false){
   var x = 2;
}

Ви не можете реально відобразити будь-який текст, але, принаймні, це більш помітний маркер, особливо якщо ви схильні до (більшості) попереджень, як помилок.

Я запропонував та реалізував цю функцію, і вона поставляється із Swift 4.2. Ви можете використовувати його зараз, завантаживши ланцюжокmaster інструментів на swift.org .

#if os(macOS)
  #error("macOS is not supported")
#endif
#warning("finish this")

Один CocoaPod, який я використовував, мав .swiftсвою назву, тому каталог було повернуто, що спричинило збій сценарію від Kyle. Додавання -type fдо findкоманди усуває цю проблему, лише переглядаючи файли, які відповідають, *.swiftа також повертаючи каталоги, що відповідають шаблону.

Кінцевий код, який я використав:

TAGS="TODO:|FIXME:"
echo "searching ${SRCROOT} for ${TAGS}"
find "${SRCROOT}" \( -name "*.swift" \) -type f -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($TAGS).*\$" | perl -p -e "s/($TAGS)/ warning: \$1/"

Якщо ви не хочете налаштувати налаштування, ще один простий домашній засіб - приклеїти заповнювач редактора перед коментарем:

<#todo#>// stop and fixme!

Ви отримуєте помилку "Редактор заповнювача у вихідному файлі" під час створення, але на відміну від рішення Джордана, немає живої помилки, яка б вас дратувала під час введення тексту:

Після довгих пошуків і туг я переконаний, що такої сутності немає. Я все ще сподіваюся, що останні нотатки про випуск Xcode згадують постійну відсутність механізму позначення #pragma, # попередження та #error також можуть надходити.

На відміну від цього, я настійно рекомендую подати Радар з Apple на bugreport.apple.com, щоб додати цю функціональність (можна обійтись 17702491).

Ми написали інструмент, що налаштовується, що дозволяє встановлювати попередження та помилки в Навігаторі Xcode Issue на основі тегу коментарів та конфігурації збірки: https://github.com/doubleencore/XcodeIssueGenerator

Встановіть його:

brew tap doubleencore/tap
brew install xcodeissuegenerator

Потім поставте рядок у фазі збірки сценарію запуску:

# Mark WARNINGs, SERIOUSs, and TODOs as warnings in DEBUG builds excluding the Vendor and Third Party directories.
XcodeIssueGenerator -b DEBUG -w "WARNING, SERIOUS, TODO" -x "Vendor/, Third Party/"

Ось стаття, що описує, як ми ним користуємося.

Я можу запізнитися на вечірку з Xcode 10, що підтримує помилки та попередження, але просто розміщую String:

"Need to finish implementing this"

видасть попередження: String literal is unusedавтозавершення все ще працює, а проект все ще складається.

Моя відповідь не зовсім задовольняє ваше запитання, але якщо ви хочете чогось легкого, ви можете використовувати цей плагін alcatraz, який працює у всіх проектах без додаткових підготовлень. Просто виконайте наступне:

1) install Alcatraz (Nice package manager for Xcode Plug-ins) by entering this line in terminal: 
curl -fsSL https://raw.githubusercontent.com/supermarin/Alcatraz/deploy/Scripts/install.sh | sh
2) Then restart Xcode and on it launch agree to install all bundles not included in Xcode
3) In Xcode select menu item -> Window -> Package manager -> type in search panel XTodo and press install
4) Relaunch Xcode and again agree to install additional bundles
5) From now press Ctrl + T and you will see all Tags in nice window

Він також має переваги щодо додавання нових тегів

Перевага цього фрагмента - він не показує попередження від Pods:

if [ "${CONFIGURATION}" = "DEBUG" ]; then 
    TAGS="TODO:|FIXME:|WARNING:|warning:" find "." \( -name "*.swift" \) -not -path "./Pods/*" -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($TAGS).*\$" | perl -p -e "s/($TAGS)/ warning: \$1/"
fi

Як встановити: