Swiftで遊ぼう! - 1017 - Xcodeにコメントを加える
最初っから難しいプロジェクトに取り組むことを諦めて非常に単純なプロジェクトに取り組んでいる。自分の子供向けの学習プログラムを作ってみようと思って、取り組み始めたわけ。
でも、コードを書いていても、やっぱりオヤジは、自分で書いたコードても後で見返すと分からなくなってしまう。Xcodeでコーディングしていても、詳しいコメントを残していかないと、後で振り返っても覚えてないことばかりになる。ということで、コメントの書き方は非常に重要なんだろう。書いたメソッドの説明をちゃんと記述して残していないと全く後で使えないってことになる。情けないことにXcodeにコメントを残すルールも知らなかった。
/** 角度を与えることで円周上の位置をCGPointで返すメソッド CGRectの長方形を与えて、その長方形の短辺から円を作り、そこにラジアン角度を与えることで、円周上の位置情報をCGPointで返す - important: 角度はラジアン角度を与える必要があるので、全外周長は2πである - returns: 外周の位置情報をCGPointとして返す - parameter radianAngle: 位置を得るために角度をラジアン角度として与える - parameters: - rect: 長方形を与えることでその短辺から円の半径をもとめる */ private func topPosition(for radianAngle: CGFloat, in rect: CGRect) -> CGPoint { - -
メソッドの記述直前に、こういう風にコメントを書いて、メソッドを 「⌥ (Option) + クリック」してやると次のように説明用のウインドウが立ち上がる。
最初の行に書いた文章はSummaryに表示され、1行空欄を開けるとDiscussionに表示されるみたい。例に書いているようなタグを書いて記述すれば、それぞれの説明文が表示される。何年もXcodeを扱っていて、コメントの書き方も知らなかったとは。