読者です 読者をやめる 読者になる 読者になる

Pragmatic ball boy

iOSを中心にやってる万年球拾いの老害エンジニアメモ

Swift2 ドキュメントコメント

ドキュメントコメントを記載することで、Option + クリックでメソッドなどの説明を表示したりするようにすることができます。

ドキュメントコメントの指定方法は2通りあり、複数行の場合は/* ... /で囲い、一行の場合は///で始めます。

/**
 say message
 */
func say(message: String) -> String {
/// say message
func say(message: String) -> String {

関数の説明

テキストをそのままかけば関数の説明として扱われます

/// say message
func say(message: String) -> String {

引数の説明

引数一個の場合

/// say message
/// - parameter message: a message what you want to say
func say(message: String) -> String {

引数複数の場合

/// say message
/// - parameters:
///   - message: a message what you want to say
///   - language: Japanese or English
func say(message: String, language: String) -> String {

戻り値の説明

/// say message
/// - returns: a message what did say
func say(message: String) -> String {

エラーの説明

/// say message
/// - throws: ServerError
func say(message: String) throws -> String {

その他の記法

Markdown記法を使うことができます

/// # Title
///
/// ## List
/// - a
/// - b
/// - c
///
/// ## Number List
/// 1. list1
/// 2. list1
/// 3. list1
///
/// ---
///
/// ## Reference
/// [Link](http://github.com)