NEW: Learn to build the incredible iOS 15 Weather app today! >>

Ultimate Portfolio App: Documenting our Code - Workaround tag suggestion

Forums > Videos

I find it beneficial to tag the sections of code that are workarounds. Later on, after a code platform change, it is easy to search through all the source code for the workaround code sections, and to review them for removal or amendment. I keep the workaround tag in the comment until no longer needed.

At start of a comment line, I use :workaround:

example:

// :workaround: . . .

You could use whatever tag you want, as long as it is not used for, or could be confused with anything else.

Hopefully, you may find doing this of benefit too.

   

Hacking with Swift is sponsored by Essential Developer

SPONSORED Only until this Sunday, December 12th, you can join a free crash course to learn advanced techniques for testing new and legacy Swift code — it's the fast track to becoming a complete Senior iOS Developer!

Click to learn more

Sponsor Hacking with Swift and reach the world's largest Swift community!

Reply to this topic…

You need to create an account or log in to reply.

All interactions here are governed by our code of conduct.

 
Unknown user

You are not logged in

Log in or create account
 

Link copied to your pasteboard.