[Swift] VVDocumenter-Xcode で Swift プロジェクトの API ドキュメントを記述する | DevelopersIO
VVDocumenter-Xcode VVDocumenter-Xcode は iOS アプリの API ドキュメントを効率的に書くための、一番有名な Xcode プラグインです。「///」と入力するだけで構文を自動入力してくれます。 Swift でも使えないかなぁ？と思って改めて Readme を読んでみたら次のような記述がありました。 Swift Support Yes, this plugin supports documentation for Swift now. Check this post from @mattt to see how to write the documentation for swift. By using VVDocumenter-Xcode, you can just type /// to make the magic happen. お！できるよ
![[Swift] VVDocumenter-Xcode で Swift プロジェクトの API ドキュメントを記述する | DevelopersIO](https://cdn-ak-scissors.b.st-hatena.com/image/square/c8795c64527cfaed8ded2bedc348e198965dbeb2/height=288;version=1;width=512/https%3A%2F%2Fdevio2023-media.developers.io%2Fwp-content%2Fuploads%2F2014%2F06%2Fswift.png)
Swiftでヘッダドキュメント - tsntsumi’s NOOTO
メソッドや関数のヘッダコメントに、その説明を書くのは JavaDoc 以前からよく行われていたドキュメンテーションの方法ですが、Swift では JavaDoc スタイルの記述方法がうまく働かなくなっていました。「@param」や「@return」が認識されないのです。 これ、「@param」ではなく「:param:」、「@return」ではなく「:returns:」だと認識してくれるみたいです。 (参考: http://nshipster.com/swift-documentation/ ) ただし、Description と :param: の行の間には空行を挟む必要があるようです。 また、リストも行頭に「-」または「+」をつければ、簡単にかけるようです。 コメントも「/**」「*/」で囲む方法ではなく、行頭に「///」でもよいようです。 追記: 番号付きリストや、定義リスト、ブロック
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
