Swift 주석

이 문서에서는 Swift 주석, 왜 그리고 어떻게 사용하는지에 대해 배울 것입니다.

주석은 프로그램 소스 코드에서 프로그래머가 읽을 수 있는 설명이나 주석입니다. 컴파일 코드를 할 때, 컴파일러는 그것을 무시합니다.

주석은 코드의 의도와 기능을 더 잘 이해하도록 돕기 위해 있습니다. 팀에서 작업할 때 다른 팀원들에게 코드의 목적을 명확히 설명하는 데 도움이 될 수 있으며, 혼자 작업할 때 자신에게 경고할 수 있습니다.

Swift 주석 및 유형

Swift는 두 가지 주석 유형이 있습니다:

1.단一行 주석

Swift에서, 두 개의 슬래시(/)로 시작하는 모든 것이 // 로 시작하는 행은 모두 단一行 주석이며, 두 개의 슬래시(/)로 시작하는 모든 행은 // 로 시작하는 행은 모두 컴파일러에 의해 무시됩니다.

playground의 상단에 간단한 예제를 찾을 수 있습니다:

//: Playground　-　명사: 사람들이 놀 수 있는 곳

로 시작합니다. // 로 시작하고, 파일에 의미 있는 설명을 제공합니다. 예를 들어: "Playground" - 명사: 사람들이 놀 수 있는 곳

예제1：단一行 주석

//Sample program
//stores　3.14　in variable pi
let pi =　3.14159　
print(pi)

위의 예제는 두 개의 단一行 주석을 포함하고 있습니다：

//　Sample program
//　stores　3.14　in variable pi

2.다중 행 주석

다중 행 주석이 여러 행을 포함하면, 그것을 중간에 괄호로 둘러싸세요/*...*/。

다중 행 주석은 슬래시(/)로 시작하고, 별표(*)로 끝납니다/*) 별표로 끝나고, 정사각형 괄호와 슬래시(/)로 시작합니다*/) Swift 컴파일러는 무시합니다/* 및 */이 간격에 있는 모든 내용.

/*　이것은 다중 행 주석입니다.
다중 행 주석을 작성한 후에 추가하세요*그리고/으로 끝납니다
*/

예제2：다중 행 주석

/*　하드코딩된 pi 값은 그렇지 않을 수 있습니다.
따라서, 내장 데이터 타입을 사용하여 더 정확한 값을 계산할 수 있습니다.
*/
let pi = Double.pi
print(pi)

위의 예제는 다중 행 주석을 포함하고 있습니다.

/*　하드코딩된 pi 값은 그렇지 않을 수 있습니다.
따라서, 내장 데이터 타입을 사용하여 더 정확한 값을 계산할 수 있습니다.
*/

기억해야 할 점

주석은 코드의 의도를 더 잘 이해하는 데 매우 유용하지만, 주의해야 할 점이 있습니다:

1. 다중 행 주석에 주석을 포함하지 마세요.//중국어, 그러나 그것이 유효하면 할지라도 컴파일러는 이러한 행을 무시합니다. 대신, 다중 행 주석에 넣어야 합니다./* ... */중
   예를 들어:

   //이것은 주석입니다.
   //필요할 때만 정확하게 사용하십시오

   위의 주석 작성 방법은 올바르지만, 주석이 여러 행이 되는 경우 다중 행 주석을 사용하는 것이 좋습니다:

   /*　이것은 주석입니다.
   필요할 때만 정확하게 사용하십시오
   */

2. 단一行 주석은 단一行으로 작성할 수 있으며, 코드와 함께 동일한 행에 작성할 수도 있습니다. 그러나 단独行 주석을 사용하는 것이 좋습니다.
   예를 들어:

   let pi =　3.14159　//stores　3.14　in variable pi

   이렇게 주석을 작성하는 방법은 효과적입니다. 그러나 주석이 단一行이 아닌 경우, 다중 행 주석을 사용하는 것이 좋습니다:
   

   //stores　3.14　in variable pi
   let pi =　3.14159

3. 단 하나의 개발자로서 팀에 속해 있고, 코드를 단독으로 작성하는 경우, 주석이 없으면 프로그램에서 코드의 용도를 찾기 어려울 수 있습니다. 따라서 정확하게 사용하고, 의미 있는 설명을 제공하십시오.

4. 주석을 매우 간단하고 의미 있게 만들십시오.

5. 불필요한 주석을 코드에 쓰지 마십시오.

6. 대부분의 경우, '왜'를 설명하는 것이 아니라 '어떻게'를 설명하는 데 주석을 사용하십시오.