タグ

ブックマーク / qiita.com/roworks (2)

  • Swift 2 で強化されたコメント表記をまとめた #2 - Qiita

    Swift 2 で強化されたコメント表記をまとめた #1では、Line formmatingについて書きました。 今回はSymbol Sectionについて書きます。 Symbol Sectionは、メソッドのパラメータや戻り値を書くためのフォーマットです。 ちなみに、Symbol Sectionは、VVDocumenter-XcodeというXcodeのプラグインを使うと簡単に記述できるのでおすすめです。 ここにドキュメントがあります。 基的なフォーマット パラメータ 「- parameter パラメータ名: 詳細」というフォーマットで1つずつ記載します。 複数のパラメータがある場合には、 「- parameters:」を書き、次の行に「- パラメータ名: 詳細」で記載することもできます。 /** - parameter パラメータ名1: 詳細 - parameter パラメータ名2:

    Swift 2 で強化されたコメント表記をまとめた #2 - Qiita
    hundret
    hundret 2016/02/09
    Swift 2 で強化されたコメント表記をまとめた #2 by @roworks on @Qiita
  • Swift 2 で強化されたコメント表記をまとめた #1 - Qiita

    XcodeでSwift1.xのコードを変換すると、文書コメント(関数やメソッドなどのコメント)も一緒にコンバートされるので気づいた人もいると思いますが、文書コメントの記法が変わりました。 以前はパラメータやリターンコード、あとはリスト表記など簡単なものしかありませんでしたが、Swift 2になりmarkdown記法に似た感じに変更され、コメントコマンドもかなり増えてます。 Playgoundのドキュメントレンダリング用とシンボルドキュメントで記法が若干違うのですが、今回シンボルドキュメントの方を中心に書いてみました。 ここにドキュメントがあります。

    Swift 2 で強化されたコメント表記をまとめた #1 - Qiita
    hundret
    hundret 2016/02/09
    Swift 2 で強化されたコメント表記をまとめた #1 by @roworks on @Qiita
  • 1