Swift

【Swift】わかりやすいプログラムを目指す!コメントの使い方

こんにちは!KON(@pippi_kon)です。

この記事は、主にプログラミング言語「Swift」の初心者向けに、iPhoneアプリを作るための情報を記載しています。

今回は、プログラムをわかりやすくするコメント」についてご紹介します。

バージョン情報

この記事は以下のバージョンで記載しています。

Xcode:9.4.1

Swift:4.1.2(Swift)

コメントとは

コメントとは、プログラム内に書けるメモや説明文のことです。

コメントはプログラム実行時に無視されるため処理に影響を与えることはありません

コメントはとても重要です。

プログラムが長くなってくると、どこでどのような処理が行われているかがわかりにくくなってきます。

1行ずつ順番に解読していくのは疲れますし非効率です。

 

そんな時に活躍するのがコメント

 

コメントで「ここはこんな処理をしてるよ」と説明文をつけておけばプログラムを読みやすくなります

また、プログラムを他人と共有する時にも非常に有効です。

人が書いたプログラムは読みにくい(自分のスタイルと違うから)ので、コメントを書いてあげると親切ですね。

さらに、プログラムコードを退避する場合にも便利です。

プログラムコードで不要になった部分があるけど、あとでまた復活させるかもしれないので消したくない…

そんな時はプログラムをコメント化して(コメントアウトという)実行されないようにしましょう。

コメントの便利な点
  • 処理の説明ができる
  • プログラム内にメモ書きできる
  • プログラムコードを退避できる

 

コメントは諸刃の剣

コメントはとても便利なものだと言ってきましたが、実は諸刃の剣でもあります。

なぜならコメントに間違いが書いてあるおそれがあるからです。

単に間違っているパターンもあれば、プログラム改修によって処理が変わったパターンもあります。

コメントに書いてあることだけを信じてプログラムを作成するとバグを作り込んでしまうおそれがあります。

プログラム追加・修正する際は、あくまでコメントは参考程度にし、プログラムの前後関係は必ず確認しましょう

 


書式

コメントは2種類の記述方法があります。

書式1

// 1行コメント

 

書式2

/* 複数行コメント */

 

使い方

以下の2パターンの使い方についてご紹介します。

(1)1行コメント

(2)複数行コメント

なお、いずれのパターンもSingle View Appプロジェクトを作成した直後の状態を前提としています。

あわせて読みたい
【Swift】基本的なプロジェクト(Single View App)の作成方法 この記事は、主にプログラミング言語「Swift」の初心者向けに、iPhoneアプリを作るための情報を記載しています。 今回...

(1)1行コメント

1行コメントはその名の通り1行だけコメント文を記述できるものです。

2つの半角スラッシュ(//)からその行の終わりまで」がコメントになります。

サンプルプログラム

 

実行結果


このようにConsoleに表示されます。

定数のnameとageにコメントをつけましたが処理に影響はありません。

また、コメント化されたprint文は実行されません。

 

全プログラムコード

 

(2)複数行コメント

複数行コメントはその名の通り複数行のコメント文を記述できるものです。

/*から*/まで」がコメントになります。

「/」は半角スラッシュ、「*」は半角アスタリスクです。

なお、複数行コメントで1行だけコメントすることもできます。

サンプルプログラム

 

実行結果


このようにConsoleに表示されます。

 

全プログラムコード

 


まとめ

いかがだったでしょうか?

今回は「コメント」の使い方についてご紹介しました。

コメントはプログラミングをする上では欠かすことのできない重要な機能の一つです。

コメントの便利な点
  • 処理の説明ができる
  • プログラム内にメモ書きできる
  • プログラムコードを退避できる

ただし、コメント内容は正しく書かないとバグを作り込むきっかけになってしまうので注意しましょう。