주석다는 방법

  • 간단하게 나눗셈을 하는 함수를 예로 들면 다음과 같이 주석을 작성한다.
/**
 두 수를 나눈 결과를 반환하는 함수.
 
 - parameters:
    - numerator: 분자
    - denominator: 분모
 
 - returns: 두 수를 나눈 결과값
 */
func devide(numerator: Int, denominator: Int) -> Float {
    return numerator / denominator
}
  • 결과


Jazzy를 이용한 문서화

  • Realm에서 만든 Jazzy 툴을 사용하면 애플 스타일의 html을 만들 수 있다.
  • 터미널에서 sudo gem install jazzy. 로 jazzy를 설치할 수 있다.
  • 설치가 완료되면 해당 프로젝트 경로에서 jazzy --min-acl internal로 문서화 시킬 수 있다.
import UIKit



class ViewController: UIViewController {
    // MARK: - Properties
    // MARK: Custom Variable
    var name: String?
    
    
    
    // MARK: - Methods
    // MARK: View Life Cycle
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        self.printYour(name: self.name ?? "이름이 없습니다")
    }
    
    // MARK: Memory Management
    
    override func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
    }
    
    // MARK: Custom Function
    /**
     parameter를 print 하는 함수.
     
     - parameters:
        - name: print될 이름
     */
    func printYour(name: String) {
        print(name)
    }

}
  • 결과