Skip to main content

よく見る命名規則など

ファイル名の「＋」 → Extension​

たとえば CGSize で extension を書いたら、
ファイル名は CGSize+Scale.swift のように、「クラス名 + 拡張する内容」という命名

コメントの「 /// 」 → ドキュメンテーションコメント​

  • 関数 / 変数名などの「宣言」の直前に書くと、ドキュメンテーションコメント(DocC形式) と認識される
  • 書いておくとXcode で Opt + クリック 操作で表示されるようになる
  • /// の他に /** .. */ でも良い

DocC は、この順番で記載するもの

  1. 概要 ・・・ 先頭行
  2. 詳説 ・・・ 続きの行。Markdown が使用可
  3. パラメータ/戻り値

例：

swift
/// 2値の最大値を返します。
///
/// `a` と `b` を比較して大きい方を返します。
///
/// - Parameters:
///   - a: 1つ目の値
///   - b: 2つ目の値
/// - Returns: 大きい方の値
/// - Complexity: O(1)
func max(_ a: Int, _ b: Int) -> Int { a > b ? a : b }