/// Let's say something
///
/// @param bar I'm paramter
/// @return I'm return value
- (id)fooBar:(NSString *)bar;
复制代码

///
/// Let's say something
///
/// - Parameter bar: I'm paramter
/// - Returns: I'm return value
func foo(bar: String) -> AnyObject { ... }
复制代码

/**
 Hello, documentation

 [土土Edmond木](https://looseyi.github.io/)

 # Lists

 You can apply *italic*, **bold**, or `code` inline styles.

 ---

 # Unordered Lists
 - Lists are great,
 - but perhaps don't nest;
 - Sub-list formatting...
 - ...isn't the best.
 ---

 ## Ordered Lists
 1. Ordered lists, too,
 2. for things that are sorted;
 3. Arabic numerals
 4. are the only kind supported.
 */
复制代码

/**
 Creates a personalized greeting for a recipient.

 - Parameter recipient: The person being greeted.

 - Throws: `MyError.invalidRecipient`
           if `recipient` is "Derek"
           (he knows what he did).

 - Returns: A new string saying hello to `recipient`.
 */
func greeting(to recipient: String) throws -> String {
    guard recipient != "Derek" else {
        throw MyError.invalidRecipient
    }

    return "Greetings, \(recipient)!"
}
复制代码

/// Returns the magnitude of a vector in three dimensions
/// from the given components.
///
/// - Parameters:
///     - x: The *x* component of the vector.
///     - y: The *y* component of the vector.
///     - z: The *z* component of the vector.
func magnitude3D(x: Double, y: Double, z: Double) -> Double {
    return sqrt(pow(x, 2) + pow(y, 2) + pow(z, 2))
}
复制代码

/**
 The area of the `Shape` instance.

 Computation depends on the shape of the instance.
 For a triangle, `area` is equivalent to:
 ```
 let height = triangle.calculateHeight()
 let area = triangle.base * height / 2
 ```
*/
var area: CGFloat { get }
复制代码

/**
 The perimeter of the `Shape` instance.

 Computation depends on the shape of the instance, and is
 equivalent to:

 ~~~
 // Circles:
 let perimeter = circle.radius * 2 * Float.pi
 // Other shapes:
 let perimeter = shape.sides.map { $0.length }
 .reduce(0, +)
 ~~~
 */
var perimeter: CGFloat { get }
复制代码

// MARK: - CustomStringConvertible

extension Bicycle: CustomStringConvertible {
    public var description: String {
        var descriptors: [String] = []
        ...
       
        // FIXME: Use a distance formatter
        descriptors.append("...")

        // TODO: Allow bikes to be named?
        return descriptors.joined(separator: ", ")
    }
}
复制代码

/// 🚲 A two-wheeled, human-powered mode of transportation.
class Bicycle {
    /// Frame and construction style.
    enum Style {
        /// A style for streets or trails.
        case road

        /// A style for long journeys.
        case touring

        /// A style for casual trips around town.
        case cruiser

        /// A style for general-purpose transportation.
        case hybrid
    }

    /// The style of the bicycle.
    let style: Style

    /// The size of the frame, in centimeters.
    let frameSize: Int

    /// The number of trips traveled by the bicycle.
    private(set) var numberOfTrips: Int

    /// The total distance traveled by the bicycle, in meters.
    private(set) var distanceTraveled: Double

    /**
     Take a bike out for a spin.

     Calling this method increments the `numberOfTrips`
     and increases `distanceTraveled` by the value of `meters`.

     - Parameter meters: The distance to travel in meters.
     - Precondition: `meters` must be greater than 0.
     */
    func travel(distance meters: Double) {
        precondition(meters > 0)
        distanceTraveled += meters
        numberOfTrips += 1
    }
}
复制代码

[sudo] gem install jazzy
复制代码

$ git clone https://github.com/Alamofire/Alamofire
$ cd Alamofire
$ bundle install
$ bundle exec jazzy -o Docs
复制代码

$ bundle exec jazzy \
  -o Docs \
  --module Alamofire \
  --swift-build-tool spm \
  --build-tool-arguments -Xswiftc,-swift-version,-Xswiftc,5
复制代码

source "https://rubygems.org"

gem "fastlane"
gem "cocoapods"
gem "jazzy"
gem "xcode-install"
复制代码

$ bundle install
$ bundle exec jazzy \
  -o Docs \
  --objc \
  --umbrella-header AFNetworking/AFNetworking.h \
  --framework-root AFNetworking
复制代码

# 输出 SourceKitter 的 Swift 文档数据到 json
sourcekitten doc -- -workspace MyProject.xcworkspace -scheme MyScheme > swiftDoc.json

# 输出 SourceKitter 的 Objective-C 文档数据到 json
sourcekitten doc --objc $(pwd)/MyProject/MyProject.h \
      -- -x objective-c  -isysroot $(xcrun --show-sdk-path --sdk iphonesimulator) \
      -I $(pwd) -fmodules > objcDoc.json

# 合并 swift 和 Objective-C json 并输出文档
jazzy --sourcekitten-sourcefile swiftDoc.json,objcDoc.json
复制代码