CODEWITHSUNDEEP
xcodetagsxcode4commentstodo
Ben
Ben

Reputation: 835

Xcode using FIXME, TODO, ???,?

I have started to use the FIXME, TODO, ??? and !!! tags in XCode but have am finding it painful that it does not recognise the tags when they are within a function. The tags are only recognised outside a given function.

How can I get these tags recognised within a function (as this is where the bugs are)?

Upvotes: 42

Views: 29912

Answers (9)

lundhjem
lundhjem

Reputation: 618

If you want to continue developing but need to ensure your app doesn't get released with a leftover //FIXME: you can do the following as an alternative.

Define this somewhere in one of your headers:

#if DEBUG
#define FIXME 0;
#endif

This definition lets your app build for debug but prevents it from being archived for release.

Now you can use FIXME anywhere you would've used the comment.

Ex: NSNumber *magicNumber = 7; FIXME

Upvotes: 0

HixField
HixField

Reputation: 3786

This is the script I use as an added build phase, note it excludes files pulled-in via Carthage (very annoying to get these as well otherwise since its not 'your' code) :

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

Works well on xCode 9.3 with Swift 4

Upvotes: 0

Florian
Florian

Reputation: 501

Edited 2016-02-02

Xcode now supports //MARK:, //TODO: and //FIXME: landmarks to annotate your code and lists them in the jump bar.

To find those special markups (and actually any markups you specify yourself), you can use the search navigator, enter the following string and then choose "In Project, matching regex "...", ignore case":

(//FIXME|//!!!|//\?\?\?|//TODO)

This will search your project for all those special markups. You can even add any markup you would like to, e.g. "//REVIEW: please review the following code". This would then be the following search string:

(//FIXME|//!!!|//\?\?\?|//TODO|//REVIEW)

I created a tab in my workspace which has the search navigator always open, filled with this string. Unfortunately, XCode will sometimes remove this string from the searchbox, so you have to have it copy&paste ready whenever you need it.

Upvotes: 20

Ramis
Ramis

Reputation: 16609

xCode 6 beta 4 should support MARK, TODO and FIXME landmarks.

Xcode now supports //MARK:, //TODO: and //FIXME landmarks to annotate your code and lists them in the jump bar. (14768427)!

Upvotes: 4

Travis Worm
Travis Worm

Reputation: 166

how about this Xcode plugin? --> https://github.com/trawor/XToDo

Upvotes: 4

Yarmoshy
Yarmoshy

Reputation: 79

Just a heads up, but I've noticed the TODO:'s do not work within blocks of any kind. Just move it right above or below your block.

Upvotes: 2

frank
frank

Reputation: 597

A workaround is to use a build script which marks those as warnings:

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

Credit to Benjamin Ragheb.

Upvotes: 37

Johan
Johan

Reputation: 2507

The FIXME:, TODO:, ???: and !!!: works in 4.3.3 inside and outside of functions.

You can have any number of whitespace before or after the double slash, but you have to use uppercase and follow the tag with a colon.

Just to make it clear - all of these work:

//          FIXME: This works.
  //TODO: This works.
    //                  !!!: Working.
// // //???: Works as well.

Upvotes: 8

loomer
loomer

Reputation: 2017

In xcode 4.1 (don't know if this works in previous versions) I write

#warning TODO: fix this later...

to get a compile warning or

#error FIXME: fix now!

to get a compile error.

I also add these to the code snippet library to make it really ease to add todos.

Upvotes: 51

Related Questions