[Swift] 주석(Comment)

프로그램을 개발할 때에 로직에 영향을 주지 않고 메모를 하거나, 특정 부분의 기능을 더 이상 사용하지 않거나 임시로 기능을 막고 싶은 경우가 있다.
이런 경우 사용하는 것이 주석문이다. 주석문을 사용하면 코드의 가독성이 늘어날 뿐만 아니라, 유지보수나 업무 파악에도 도움이 된다.
Swift에서는 주석문을 어떻게 사용하는지 알아보도록 하자.

---

주석문 사용

1. 한 줄 주석

Swift에서는 C언어와 마찬가지로 //를 사용하여 해당 줄을 주석문으로 처리한다.

// Comment

2. 여러 줄 주석

여러 줄을 주석문으로 처리할 경우, 한 줄 주석을 여러 번 사용할 수 있다.
하지만, 매우 비효율 적이다.

// Comments
// Comments
// Comments

따라서, 여러 줄을 주석문으로 처리하기 위해서는 /*와 */ 를 사용하는 것이 훨씬 효율적이다.

/*
	Comments
	Comments
    Comments
*/

여기 까지는 코딩을 조금이라도 해본 사람들은 모두 알만한 주석문의 사용법이다. 하지만, Swift에서는 이 주석문을 통하여 가독성이 훨씬 좋아지게 만들 수 있는 방법이 있다. 바로 MARK 이다.

---

MARK

MARK는 현재 작성하고 있는 Swift 파일의 구성을 훨씬 편하게 볼 수 있게 해준다.
MARK를 사용하는 방법은 아주 간단하다.

// MARK: Comment

기존 주석문 //에 MARK:만 추가해주면 된다.
그래서 MARK를 추가하면 어떻게 되냐면..

이렇게 현재 파일의 목록에서 Create UI items나 Funcs for ... 같이 MARK에서 쓴 주석문들의 내용이 보여지게 된다.
파일의 구성을 조금 더 쉽게 확인할 수 있지만 그래도 뭔가 부족하다. 조금 더 보기 편하게 만들어주고 싶다. 라고 생각한다면, - 문자 하나만 추가해주면 된다.

// MARK: - Comment

- 하나만 추가해도 많은 것이 달라지게 된다.

이런 식으로, 기존 주석문 표시 위에 선 하나가 그어진다. 훨씬 가독성이 좋아졌다.
MARK: -를 사용하면 파일 구성 목록 뿐만 아니라, 실제 코드 내에서도 선이 그어지기 때문에 코드를 볼 경우에도 가독성이 좋아진다.

MARK를 잘 사용한다면, 코드를 작성할 때 뿐만 아니라 유지보수를 할 때에도 훨씬 편하게 작성할 수 있을 것이다.

---

TODO & FIXME

MARK와 같이 사용할 수 있는 문자에는 TODO와 FIXME도 있다.
사용법은 MARK와 똑같지만, TODO는 코드를 작성해야 할 부분에 주석을 남길 때 사용하고 FIXME는 고쳐야 할 부분에 주석을 남길 때 사용한다.

Xcode에서 직접 사용해보면 알겠지만, MARK와 TODO, FIXME를 사용할 경우에는 글씨체가 bold체로 바뀐다.

---

깃허브에서 다른 분이 사용하시는 것을 보고 저도 이번에 알게 되었는데, 사용해보니까 가독성이 정말 좋아졌습니다.
앞으로 잘 활용해서 협업을 하거나 유지보수할 때, 다른 분들이 알기 쉽게 자주 사용해야겠다고 느꼈습니다.