Swiftのコメントを完全マスターするための12選

はじめに
●Swiftのコメントとは
- ○コメントの基本
  - □一行コメント
  - □複数行のコメント
●Swiftのコメントの使い方
●Swiftのコメントの応用例
●Swiftコメントの注意点と対処法
- ○サンプルコード8：不適切なコメントの書き方とその対処法
- ○サンプルコード9：コメントとコードの整合性を保つ方法
●Swiftコメントのカスタマイズ方法
- ○サンプルコード10：Xcodeのカスタマイズ機能を利用したコメントのスタイリング
まとめ

はじめに

プログラムを書くとき、特に他の人との共同作業や自分が将来見返すために、コメントは非常に重要です。

Swift言語でもコメントは重要な役割を果たしています。

この記事では、Swiftのコメントを活用するための基本から、さらに深い部分までを解説していきます。

この記事を読めばSwiftのコメントを活用する方法を完全にマスターすることができるようになります。

●Swiftのコメントとは

Swift言語においても、他の多くのプログラミング言語と同様、コメントをコード中に埋め込むことができます。

コメントはコードが実行される際には無視されるため、その内容に関係なく、プログラマーの意図や説明を記述するのに適しています。

○コメントの基本

Swiftには主に2つのコメントの書き方があります。

□一行コメント

一行コメントは、その行のみのコメントを書くために使用されます。

このコードでは//を使って一行コメントを書いています。

let number = 5 // これは一行コメントです
print(number)

このコードを実行すると、5が表示されます。

// これは一行コメントです という部分は実行時には無視されます。

□複数行のコメント

複数行のコメントは、複数行にわたる長い説明やコメントを書くために使用されます。

このコードでは/*と*/を使って複数行のコメントを書いています。

/*
これは
複数行の
コメントです。
*/
print("Hello, Swift!")

このコードを実行すると、”Hello, Swift!”と表示されます。

上の4行は実行時には全て無視されます。

●Swiftのコメントの使い方

Swiftでコメントを適切に使用することは、コードの可読性を高めるために極めて重要です。

特にチームでの開発を行う際や、数ヶ月後、数年後に自分の書いたコードを再度見返す場面など、コメントの存在はコードの理解を助ける大きなツールとなります。

○サンプルコード1：一行コメントの基本的な使い方

Swiftで最も一般的に使用されるコメントは、一行コメントです。

これは、コードの特定の行に対して簡潔な説明やメモを追加する場面で使用します。

このコードでは//を使って、変数の説明を一行コメントで書いています。

let appleCount = 5 // りんごの個数
print(appleCount)

このコードを実行すると、5という数字が表示されます。

ここで、// りんごの個数というコメント部分はコードの実行には影響を与えません。

○サンプルコード2：複数行のコメントの基本的な使い方

場合によっては、一行よりも長い説明や複数行にわたるメモをコードに追加する必要があります。

そのような場合、複数行のコメントを使用します。

このコードでは、/* から */ までの間に複数行のコメントを書いています。

/*
 この部分は
 複数行にわたる
 コメントです。
 */
let orangeCount = 10
print(orangeCount)

このコードを実行すると、10という数字が表示されます。

4行にわたるコメント部分は、コードの実行には影響を与えない点に注意してください。

○サンプルコード3：コードの中でのコメントの役割

コメントは、ただの説明だけでなく、コードの一部を一時的に無効化するためにも使用されます。

特に、デバッグ中や、特定の機能を一時的にオフにしたい場合などに役立ちます。

このコードでは、一部の処理をコメントアウトしています。

let grapeCount = 15
// print(grapeCount)

このコードを実行すると、何も表示されません。

なぜなら、print(grapeCount)がコメントアウトされているため、この部分は実行されないからです。

コメントを活用することで、一時的に特定の処理をスキップすることも可能です。

●Swiftのコメントの応用例

Swiftのコメント機能は基本的な使い方だけでなく、さまざまな応用的なシチュエーションで非常に役立ちます。

ここでは、そのような高度な使い方をいくつか紹介していきます。

○サンプルコード4：関数やメソッドの説明に使用

関数やメソッドの上部にコメントを記述することで、それらの役割や使い方を明確にすることができます。

特に複数のパラメータや戻り値を持つ関数では、このようなコメントが非常に役立ちます。

このコードでは、ある数値を二乗する関数を定義し、その上部にコメントで説明を追加しています。

/// 数値を二乗して返す関数
/// - Parameter num: 二乗する数値
/// - Returns: 二乗した結果
func square(num: Int) -> Int {
    return num * num
}

このコードを利用すると、square(num: 5)のように関数を呼び出すことで、25という結果が得られます。

○サンプルコード5：複雑な処理をステップごとに解説

特に複雑なロジックやアルゴリズムを実装する際、ステップごとにその動作を説明するコメントを追加することで、後からコードを読む人が理解しやすくなります。

このコードでは、配列の各要素を二乗して新しい配列を作成する処理をステップごとに解説しています。

let numbers = [1, 2, 3, 4, 5]

// 1. 空の配列を用意
var squaredNumbers: [Int] = []

// 2. 元の配列の各要素を順に取り出す
for number in numbers {
    // 3. 取り出した要素を二乗
    let squared = number * number
    // 4. 二乗した結果を新しい配列に追加
    squaredNumbers.append(squared)
}

print(squaredNumbers)

上記の処理を経て、[1, 4, 9, 16, 25]という新しい配列が得られます。

ステップごとのコメントがあることで、この複雑な処理の流れが一目でわかるようになっています。

○サンプルコード6：TODOやFIXMEタグの利用

Swiftでのコーディング中に、後で修正や追加をする必要がある部分を一時的にマークする際、TODOやFIXMEといった特別なタグを利用することが推奨されています。

これらのタグを使用することで、後でコードの該当部分を簡単に探し出すことができます。

このコードでは、TODOとFIXMEのタグをどのように活用するのかを表しています。

func fetchData() {
    // TODO: データ取得ロジックの実装
}

func calculateValue(a: Int, b: Int) -> Int {
    // FIXME: 正確な計算方法を後で修正
    return a + b
}

上記のサンプルにおいて、fetchData関数ではデータ取得のロジックが未実装であることをTODOタグで表しています。

一方、calculateValue関数では計算方法に問題がある可能性を示すためにFIXMEタグを使用しています。

これらのタグを使用することで、開発の途中やチームでの開発時に、必要な修正や追加を忘れずに行えるようになります。

○サンプルコード7：他の開発者への注意や指示を記述

チームでの開発や、将来的に自分以外の開発者がコードを読む可能性がある場合、コメントを使用して注意点や指示を明確に記述することが非常に有効です。

下記のコードは、特定の関数の使用方法に関する注意や、変数の取り扱いに関する指示をコメントとして記述した例です。

/// この関数はDBからデータを取得します。
/// - Note: 呼び出し頻度には注意してください。短時間に複数回呼び出さないでください。
func retrieveDataFromDB() {
    // 処理内容
}

// この変数はUIの更新時のみ使用してください。
var displayData: String?

このコードでは、retrieveDataFromDB関数の呼び出し頻度に注意するよう指示しています。

また、displayData変数についてはUIの更新時のみ使用することを明記しています。

●Swiftコメントの注意点と対処法

Swiftでのコメントは、コードの理解を助ける重要なツールとして利用されます。

しかし、適切に使用されないと、逆にコードの可読性を低下させる原因となり得ます。

ここでは、Swiftでのコメントの際の一般的な注意点とそれを解決するための対処法について説明します。

○サンプルコード8：不適切なコメントの書き方とその対処法

初めに、不適切なコメントの書き方を見てみましょう。

let x = 10 // xに10を代入

上記のサンプルでは、xに10を代入するという単純な処理にコメントをつけていますが、このコメントは冗長であり、コードの可読性を損ねる可能性があります。

このような自明な処理にコメントをつける必要はありません。

対処法としては、次のようにコメントを省略するか、もしくはより具体的な情報を提供する形にすることが考えられます。

let x = 10

また、適切なコメントの例として次のコードを考えてみましょう。

// 使用する際の初期値設定
let initialValue = 10

このように、変数の目的や背景に関する情報をコメントとして提供することで、他の開発者がコードを理解する手助けとなります。

○サンプルコード9：コメントとコードの整合性を保つ方法

コメントとコードの整合性が乱れると、混乱の元となります。

// xの値を5に設定
let x = 10

このサンプルでは、コメントにはxの値を5に設定すると書かれていますが、実際のコードでは10を設定しています。

このような矛盾があると、他の開発者が正しい情報を得るのが困難となります。

対処法として、コメントを更新する際は、そのコメントに関連するコードも同時に確認し、整合性を保つように心掛けることが重要です。

●Swiftコメントのカスタマイズ方法

Swiftにおけるコメントは、そのままの形式で利用するだけでなく、いくつかのカスタマイズ方法が存在します。

特にXcodeを使用している場合、その機能を活用することで、コメントをさらに効果的に使うことができます。

○サンプルコード10：Xcodeのカスタマイズ機能を利用したコメントのスタイリング

Xcodeには、ドキュメンテーションコメントを書くための特別な構文が用意されています。

この構文を使用することで、Optionキーを押しながら変数や関数名をクリックすると表示されるポップアップに、説明や注意事項を表示することができます。

ここでは、関数に対するドキュメンテーションコメントの例を紹介します。

/// 関数の説明
///
/// - Parameters:
///   - parameter1: parameter1の説明
///   - parameter2: parameter2の説明
/// - Returns: 戻り値の説明
func sampleFunction(parameter1: Int, parameter2: String) -> Bool {
    // 処理内容
    return true
}

このコードでは、sampleFunctionに対してドキュメンテーションコメントを記述しています。

このコメントを含むコードをXcodeで開き、Optionキーを押しながらsampleFunctionをクリックすると、ポップアップに関数の説明やパラメータ、戻り値の情報が表示されます。

このようなコメントの書き方を採用することで、関数や変数の詳細な情報を迅速に確認できるため、チーム開発の際に非常に有効です。

また、他の開発者がコードを読む際にも、詳しい情報を提供することができるので、コードの可読性やメンテナンス性が向上します。