UPGRADE YOUR SKILLS: Learn advanced Swift and SwiftUI on Hacking with Swift+! >>

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.

5      

BUILD THE ULTIMATE PORTFOLIO APP Most Swift tutorials help you solve one specific problem, but in my Ultimate Portfolio App series I show you how to get all the best practices into a single app: architecture, testing, performance, accessibility, localization, project organization, and so much more, all while building a SwiftUI app that works on iOS, macOS and watchOS.

Get it on Hacking with Swift+

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

Archived topic

This topic has been closed due to inactivity, so you can't reply. Please create a new topic if you need to.

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.