주석 작성법

 

코드가 많은 경우 주석이 있으면 가독성이 좋지 않을 것 같지만 그럴수록 주석을 깔끔히 작성하여,

해당 정보를 쉽게 확인하고 찾을 수 있도록 주석을 꼼꼼히 적는 버릇을 들이는 것이 중요 할 듯 하다.

 

 

한 줄 주석

 

// 슬래시 두개를 이용하여 한 줄의 주석을 작성 할 수 있다

 

 

여러 줄 주석

 

/*
여러 줄의 주석을 작성 할 때에는 '슬래시 + 별표' 로 열고,
'별표 + 슬래시' 로 닫아주면 된다.
*/

 

 

함수의 매개변수 및 반환값 설명 주석

 

/*
  - parameters:
       - a : a는 무슨 값
       - b : b는 무슨 값
  - return: 무슨 값이 반환 됨
*/

---

더 상세한 내용은 Apple Reference 문서에서 확인 할 수 있다.

참고 : @won2oppa 블로그