Thoughts on software engineering, and life.
March 9, 2025
If you are creating/maintaining a library, then generating documentation for your public APIs are crutial to creating a high quality library that people will be able to pick up, use and understand easily.
The ⌥⌘/
shortcut is a great way in Xcode to quickly generate the format required by Xcode to display your documentation in Xcode's quick help and also for when you finally build your documentation for your library.
It generates a template which you can fill out:
Without you needing to remember the correct format for writing documentation.