Xcode 주석 활용하기

평소 Xcode를 사용하면 우측 상단에 다음과 같은 그림을 많이 보았을 것이다.

주석이 없는 메소드를 선택한 경우

 

Swift의 마크다운 용어를 사용할 경우 다음과 같이 주석을 예쁘게 정리할 수 있다!

/// Writes the textual representation of each    ← Summary 요약
/// element of `items` to the standard output.
///                                              ← Blank line 빈줄
/// The textual representation for each item `x` ← Additional discussion
/// is generated by the expression `String(x)`.
///
/// - Parameter separator: text to be printed    ⎫
///   between items.                             ⎟
/// - Parameter terminator: text to be printed   ⎬ Parameters section
///   at the end.                                ⎟
///                                              ⎭
/// - Note: To print without a trailing          ⎫
///   newline, pass `terminator: ""`             ⎟
///                                              ⎬ Symbol commands
/// - SeeAlso: `CustomDebugStringConvertible`,   ⎟
///   `CustomStringConvertible`, `debugPrint`.   ⎭

짜잔

평소 주석 달 시간에 메소드명을 더 명확하게 짓고자 노력하지만

주석이 필요한 경우에 잘 활용해 보아야겠다. 😊

 

 

 

출처: https://cozzin.gitbook.io/swift-api-design-guidelines/fundamentals