読者です 読者をやめる 読者になる 読者になる

Swiftのドキュメンテーションってどうやるの?

Swift

XCode7では、SwiftドキュメンテーションはMarkdown形式となっているようだ。

Swift Documentation - NSHipster

ドキュメンテーションを記載するには/** 〜 *//// の形式でコメントを記載する必要がある。

/// 投球データを取得する
/// - Parameters:
///     - index: 投球データが格納されている配列のインデックス番号(0〜)
/// - Returns: インデックスに対応する投球データ
func getRollData(index: Int) -> Int

また、Jazzy というコマンドラインツールで ソースからHTMLのドキュメントを生成できる。