Xcode 8は自動記述を特長としています。独自のドキュメントを作成しました。説明/データ/応答/エラーのセクションに記入したいと思います。ここではスクリーンショットがあり、私の質問はAppleがどのように情報を箱に入れているかということです。私はこれに関するすべてのドキュメントを見つけることができません。 Xcode Swiftクイックヘルプクローズ
答えて
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
}
他の例およびオプションのホストがあります。そのポストに詳述されています。このような
コメントフォーマッタは、プロパティ、クラス、関数など
これが役に立てば幸いでオプションクリックしたときに表示されるドキュメントのポップオーバーに移入されます。
ありがとうございます。私はNSHipsterの答えをチェックしましたが、これは私が探していたものではありません。いつか私がAppleを除いてしなかったことをやっと私はそれを理解しました。補完ブロックに名前を付ける必要がありましたが、名前が最後に使用されたときと同じ名前が他の名前と同じ場合は、最初の名前を乗り越えるでしょう。 –
あなたの質問は、インラインドキュメントを作成する方法を知りたいと説明しています。実際にクロージャーや名前付き引数と関係があることを示すように修正することを検討してください。 –
実際に彼の質問は、彼がクロージャのパラメータ(すなわち、 "記述/データ/応答/エラーセクション"への参照)のタイトルと "クロージャ"への明示的な参照を文書化していることを完全に明確にしていると思います。この質問)。この答えは良いですが、ここでは、閉包パラメーターのパラメーターを文書化する方法についての質問には答えません。 – Rob
- 1. Googleログインxcode swift 3 xcode 8
- 2. swift xcode UIDatepicker
- 3. json xcode swift 4
- 4. iOS Swift Xcode 8.0
- 5. Xcode/Swift UIWebView
- 6. Swift 3/Xcodeテキストアライメント
- 7. タブバービューコントローラー[Swift 3.0 - Xcode]
- 8. Xcode Swift ViewDidLoad
- 9. 値型エラーSWIFT/XCODE
- 10. Swift Xcodeの配列
- 11. Xcode、Swift、Table View Controller
- 12. スローコンパイルスウィフトソースファイル - Xcode 8 swift 3
- 13. SwiftコンパイラエラーRealmSwift、Xcode 8.2
- 14. xcodeのカスタムカメラ、Swift 3
- 15. Xcode Swift 3 TableView cellselection
- 16. Xcode 7.2.1 Swift 2 - Xcode 7.3へのアップデート
- 17. Xcode 8/Swift 3:didSelectRowAtとdidSelectRowAtIndexPath
- 18. ミュージックライブラリios swift 3 xcode 8.2.1
- 19. xCodeとSwiftチュートリアルの混乱
- 20. Xcode 8とSwift 3 NSCalendar
- 21. 。Swift 4/XCode 9の(セパレータ:)?
- 22. MAC OS Xcode Swift 2.2フルスクリーンモード
- 23. Xcode 8.2 Swiftコンパイラエラー:「セグメンテーションフォールト:11」
- 24. Swiftのトラブル2 Xcode 7.3.1
- 25. Xcode 9ベータ版、Swiftコンパイラエラー
- 26. バックグラウンドでWebview.reload Xcode 8.2 swift 3
- 27. スレッド1:ブレークポイント7.3 Xcode 7 swift
- 28. Swift 2.2 Pods with XCode 8
- 29. Xcode Swift SKAction。フォロー開始地
- 30. XCode 6/Swiftボタンのラベル
「箱」とは何ですか? – matt
私は彼がスクリーンショットの下部にあるテーブルを意味すると思います – Feldur
可能な複製http://stackoverflow.com/q/38669725/1271826(ただし、確かに、答えは完全に満足できるものではありません)。 – Rob