Swift コメント

この記事では、Swiftのコメントについて学び、それがどのように使用されるかを説明します。

コメントはプログラムのソースコードの中でプログラマが読める説明やコメントです。コードをコンパイルする際には、コンパイラはそれを無視します。

コメントは、コードの意図や機能を理解するために読者に役立ちます。チームで作業する場合、他のチームメンバーにコードの目的を明確にするのに役立ちます、または一人で作業する場合、自分自身を思い出させる役割を果たします。

Swift コメント及其種類

Swiftには2種類のコメントがあります：

1.単行コメント

Swiftでは、2つの斜杠(/で始まるすべてのものは // で始まる行はすべて単行コメントであり、すべての行が2つの斜杠(/ // で始まる行はすべてコンパイラによって無視されます。

Playgroundのトップに簡単な例を見つけることができます：

//: Playground　-　名詞：人々が遊ぶ場所

で始まり、ファイルに意味のある説明を提供します、例えば「Playground」 // で始まり、ファイルに意味のある説明を提供します、例えば「Playground」 - 名詞：人々が遊ぶ場所

例1：単行コメント

//サンプルプログラム
//保存　3.14　in　変数　pi
let　pi　=　3.14159　
print(pi)

上の例には、2つの単行コメントが含まれています：

//　サンプルプログラム
//　保存　3.14　in　変数　pi

2.複数行コメント

コメントが複数行を含む場合、それを括弧の中に括ることができます/*...*/。

多行コメントは正斜杠(/で始まり、星号(*)/*)、星号で終わり、次に正斜杠(/*/)。Swift コンパイラはこれを無視します/* および */の間のすべての内容。

/*　これは複数行のコメントです。
複数行コメントを書いた後、次に*、次に/で終わります。
*/

例2：複数行コメント

/*　ハードコードされた pi 値はそれほど正確ではありません。
そのため、内蔵データ型を使用してより正確な値を計算できます。
*/
let pi = Double.pi
print(pi)

上の例は複数行のコメントを含んでいます。

/*　ハードコードされた pi 値はそれほど正確ではありません。
そのため、内蔵データ型を使用してより正確な値を計算できます。
*/

覚えておくべきこと

コメントはコードの意図をよりよく理解するのに役立ちますが、次の点に注意してください：

1. 複数行のコメントの中にコメントを含めないでください。//それが有効であっても、コンパイラはこれらの行を無視します。代わりに、それを複数行のコメントに置くべきです。/* ... */中
   例えば：

   //これはコメントです。
   //必要で正確に使用してください

   以上のコメントの書き方は正しいですが、コメントが一行以上ある場合には複数行コメントを書く必要があります。より良い書き方は、複数行コメントを以下のように使用することです：

   /*　これはコメントです。
   必要で正確に使用してください
   */

2. 単行コメントは別行に書くことができますが、コードと一緒に同じ行に書くこともできます。ただし、コメントを別行に書くことを推奨します。
   例えば：

   let　pi　=　3.14159　//保存　3.14　in　変数　pi

   このコメントの書き方は効果的ですが、コメントを別行に書くのがより良いです:
   

   //保存　3.14　in　変数　pi
   let　pi　=　3.14159

3. あなたがチームの開発者で、あなたが唯一コードを書いている場合でも、コメントがないとプログラムの中でそのコードの用途を見つけることは難しいです。正確に使用し、意味のある説明を提供してください。

4. コメントを非常にシンプルで意味のあるものにしてください。

5. 不要なコメントをコードに書かないでください。

6. 多くの場合、「どうやるか」ではなく「なぜ」を説明するためにコメントを使用してください。