Erica Sadun, "Swift Documentation Markup"
English | ISBN: n/a | 2016 | EPUB | 102 pages | 5 MB
Nearly every modern language, including Swift, offers some kind of structured comment system that documents APIs for developers that consume them. The new Swift 2 structured documentation uses a mix of custom keywords and Markdown syntax to create a simple, easy-to-apply annotation tool. By leveraging this industry-standard tech, Apple opens up its structured documentation system to an entirely new generation with an absolute minimum of training needed to get up to speed.
This short book introduces Swifts documentation markup system using simple, illustrated examples, with plenty of discussion of best practices. Youll discover the components that make up Swifts structured comment system and learn how to best integrate them into your own code. For the most part, Ive built this material out of examples from Swifts standard library, from release notes, and by reverse-engineering extensible style-sheet specifications. While Ive tried to include a thorough list of legal tokens, Ive focused on supplementing core details with a thoughtful discussion of best practices that will stand the test of time as Apple updates this system.
I hope you find this book to be a useful and worthy addition to your development library. Ive had a great time writing it. Hopefully youll have a great time reading it. Thank you for purchasing a copy!
1.2 Added CommonMark update, updated playground section, added coverage of video embedding, added various tweaks and enhancements based on material found in Apples open source content.
1.1.7 Added note about upcoming 7.3 Playground Doc keywords (experiment, note, and important) plus link to blog coverage.
1.1.6 Added coverage of Xcode 7.3/Swift 2.2s new keywords (recommended, recommendedover, keyword)
1.1.5 Expanded guidelines with Apples updated API Design Guidelines document. There isnt a big difference beyond using "s" at the end of verbs when writing descriptions.
1.1.4 Added coverage of VVDocumenters Xcode plug-in, updated Jazzy coverage
1.1.3 Errata fixes. Thank you Juan Diego.
1.1.2 Minor updates after Swift open sourced with API guidelines incorporated into a couple of discussions.
1.1.1 Added revision history (thanks, Adolofo Vera Blasco)
1.1.0 Major additions include expanded markup discussions, third party tool overviews, playground rich text documents: approximately 30% additional content.
1.0.1 Minor style fixes