Swift Documentation Markup

By Erica Sadun


Swift Documentation Markup - Erica Sadun
  • Title: Swift Documentation Markup
  • By: Erica Sadun
  • Release Date: 2015-10-15
  • Genre: Programming
    Ratings: 5 From 23 Reviews

Primary: Swift Documentation Markup.pdf - 35,138 KB/Sec

Mirror [#1]: Swift Documentation Markup.pdf - 32,690 KB/Sec

Mirror [#2]: Swift Documentation Markup.pdf - 26,473 KB/Sec

More by Erica Sadun : Swift Documentation Markup


Related Books

No matter how clear and well written, naked code is never quite self-documenting. There is always a role for comments, whether the in-line narration of key design points or the formal annotation of public declarations. Nearly every modern language, including Swift, offers some kind of structured comment system that documents APIs for developers that consume them.

The Swift 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 Swift's documentation markup system using simple, illustrated examples, with plenty of discussion of best practices. You'll discover the components that make up Swift's structured comment system and learn how to best integrate them into your own code. For the most part, I've built this material out of examples from Swift's standard library, from release notes, and by reverse-engineering extensible style-sheet specifications. While I've tried to include a thorough list of legal tokens, I've 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. I've had a great time writing it. Hopefully you'll have a great time reading it. Thank you for purchasing a copy!

-- Erica Sadun

What people are saying:

"I wish every line of #swiftlang I read in the future will be written by someone who reads the awesome [book] by @ericasadun" -- Mark Engle, @_markengle

"Just bought @ericasadun's #swiftlang Docs Markup Book. It's great for Swift devs" -- @Kametrixom

"Erica Sadun's new book, Swift Documentation Markup, an Illustrated Tour, not only explains the importance of documentation, it also comprehensively details the breadth of Xcode’s markup support...Until I read the book, I had no real idea of just how powerful this support was. In a series of clearly written sections, Erica explains how to implement features such as text formatting, category keywords and even embedded images with real world demonstrations, examples of how Apple use them and recommendations on whether they should actually be used.

The ability to add rich content to documentation means that creating code comments now feels more of a creative process and there’s a certain satisfaction to option-clicking your carefully crafted function to see a beautifully formatted comment appear. This in itself is a incentive to start documenting properly...So, thanks to Erica, expect to see a massive improvement in my own code documentation from now on." -- Simon Gladman, @FlexMonkey

"instapurchase!"  -- James O'Leary, @jpohh

"Cool book on Xcode quick help comments by @ericasadun...Oh, and did I mention the book's cover is gorgeous?" -- @blessing_Lopes

"Every dev should have this!!!" -- Vic Hudson, @vichudson1

"Thanks for this!" -- Nick Kohrn, @bnkohrn


Search
Recent Posts
Diving In - iOS App Development for Non-Programmers
Cocoa and Objective-C: Up and Running
Learn to Code in Swift 4
Flying with Objective-C - iOS App Development for Non-Programmers
iOS Programming: The Big Nerd Ranch Guide, 3/e
The Ultimate Unofficial Beginner's Guide For Playing Minecraft
Minecraft For Dummies
iOS Programming
Objective-C Programming For Dummies
Code
FileMaker & Me
Hackers
Introduction To Programming
R Programming
iOS Game Programming With Xcode and Cocos2d
Real Life Java
iPhone iOS 4 Development Essentials - Xcode 4 Edition
Básicos de Swift Vol. 1
Cocoa Programming for OS X
iPad iOS 5 Development Essentials
iOS 7 Programming Fundamentals
Swift Programming
iPhone iOS 5 Development Essentials
Introduction to Algorithms
iOS 7 App Development Essentials
Swift Programming
Tap, Move, Shake
Xcode 4 완전정복
C++
iPhone iOS 6 Development Essentials
The Formula
iOS 5 Developer's Cookbook, The: Core Concepts and Essential Recipes for iOS Programmers, 3/e
Theory of Fun for Game Design
iOS Programming
Automate the Boring Stuff with Python
Game Programming Patterns
Basic ROBLOX Lua Programming
iOS 8 App Development Essentials
Test-Driven iOS Development
The iOS 5 Developer's Cookbook: The Additional Recipes: Additional Recipes Found Only in the Expanded Electronic Edition
Version Control with Git
Patterns of Enterprise Application Architecture
Hacking with Swift
Swift Swift View Controllers
게임개발자가 대우받는 북미취업 가이드북
Refactoring: Improving the Design of Existing Code
Coding All-In-One for Dummies
iOS 9 App Development Essentials
Algorithms, 4/e
Beginner's Guide to iPhone, iPad Application Development Using iOS 5
UX Design Process
iOS Programming for .NET Developers
Building iOS Apps
Visual Basic .NET for complete beginners
Developing Mobile Games Using Swift
Learning OpenGL ES for iOS: A Hands-on Guide to Modern 3D Graphics Programming
R Programming for Data Science
iOS Auto Layout Demystified, 2/e
Functional Swift
"Quick! Make an App"
Aprende iOS: Primeros Pasos
Swift Development with Cocoa
Swift in 24 Hours, Sams Teach Yourself
A Newbies Guide to Developing an iPhone Game App
Epic SpriteKit Tutorial with Swift 3
Learning Cocoa with Objective-C
Programming iOS 11
Swift From Two to Three
Design Patterns Explained: A New Perspective on Object-Oriented Design, 2/e
Video Games
Pro Git
Learn iPhone and iPad cocos2d Game Development
Algorithms for Dummies
Beginning iPhone Development with Swift
Object Oriented Programming
Learning Core Data for iOS: A Hands-On Guide to Building Core Data Applications
Minecraft Redstone For Dummies
iOS 11 Swift Programming Cookbook
Graphics and Animation on iOS
Pro Core Data for iOS
R for Dummies
Art of Computer Programming, Volume 1
M Is for (Data) Monkey
iPad iOS 6 Development Essentials
iOS Programming
Learning AV Foundation
Idea to iPhone
Dive Into SpriteKit
Swift Quick Syntax Reference
iOS 11 App Development Essentials
The Core iOS 6 Developer's Cookbook, 4/e
The Business of iPhone and iPad App Development
Hadoop: The Definitive Guide
Head First Object-Oriented Analysis and Design
iOS 7 Application Development in 24 Hours, Sams Teach Yourself, 5/e
Mac Programming for Absolute Beginners
Objective-C for Absolute Beginners
vi and Vim Editors Pocket Reference
iOS 10 App Development Essentials
Sams Teach Yourself iOS 6 Application Development in 24 Hours, 4/e