Xcode Swiftクイックヘルプクローズ

Question

Xcode 8は自動記述を特長としています。独自のドキュメントを作成しました。説明/データ/応答/エラーのセクションに記入したいと思います。ここではスクリーンショットがあり、私の質問はAppleがどのように情報を箱に入れているかということです。私はこれに関するすべてのドキュメントを見つけることができません。

Answer 1

NSHipsterはスウィフトコードのインラインドキュメントを作成する方法についての素敵な過去記事があります。ここでは

http://nshipster.com/swift-documentation/

は抜粋です。

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

/** 
    Initializes a new bicycle with the provided parts and specifications. 

    - Parameters: 
     - style: The style of the bicycle 
     - gearing: The gearing of the bicycle 
     - handlebar: The handlebar of the bicycle 
     - frameSize: The frame size of the bicycle, in centimeters 

    - Returns: A beautiful, brand-new bicycle, custom built 
     just for you. 
*/ 
init(style: Style, gearing: Gearing, handlebar: Handlebar, frameSize centimeters: Int) { 
    self.style = style 
    self.gearing = gearing 
    self.handlebar = handlebar 
    self.frameSize = centimeters 

    self.numberOfTrips = 0 
    self.distanceTravelled = 0 
} 

他の例およびオプションのホストがあります。そのポストに詳述されています。このような

コメントフォーマッタは、プロパティ、クラス、関数など

これが役に立てば幸いでオプションクリックしたときに表示されるドキュメントのポップオーバーに移入されます。