애플 도큐먼트 구성에 대해 살펴보고, 효과적으로 활용하는 방법에 대해 알아보자🌟

1️⃣ 애플 개발자 문서(Documentation)란?

애플에서 제공하는 개발 문서로, iOS 개발에 있어 이 문서에 익숙해지고 필요한 정보를 문서로부터 습득하는 것은 매우 중요하다.

문서를 숙지함으로써 프레임워크와 클래스의 구동 방식을 이해하고 적절한 메서드/프로퍼티를 찾아 애플리케이션을 올바르게 적용할 수 있다.

또 오류가 발생했을 때 적절한 해결방안을 찾을 수 있으며 새롭게 등장하는 기술을 빠르게 이해하고 응용 가능하다.

But 영어로 되어 있는 방대한 문서들을 모두 읽는 것은 불가능하다.

그래서 Documentation이 어떻게 구성되어 있고, 필요한 정보를 쉽게 찾는 법을 안다면 iOS 개발 라이프 레벨업할 것!!!

2️⃣ Documentation 구성

참조 자료(API Reference): 클래스의 메서드와 프로퍼티에 대한 기술적인 세부사항에 관해 설명함. 코딩을 계획하거나 코딩을 하는 중에 살펴보는 말 그대로 참조용 자료

가이드(Guide): 특정 분야에 대해 상세히 소개하고, 내부적으로 어떻게 구동되는지에 대해 설명함. 관심 있는 부분만 골라서 읽어도 되지만, 모든 부분을 읽으면 예상치 못한 정보를 많이 배우게 됨. 짤막한 예제코드가 있어 코딩에 엄청 도움된다.!

샘플 코드(Sample Code): 실제로 API를 어떻게 사용하는지에 대한 예시. 동일한 기능을 애플 프로그래머는 어떻게 구현하는지 참고할 수 있음.

3️⃣ 애플 문서 읽기 팁

1. 사용하려는 클래스의 개략적인 기능 이해

사용하려는 클래스 가이드를 읽어 주요 구성요소와 기능에 대해 살펴보고, 구현하고자 하는 기능을 구현할 수 있는 다른 클래스가 있다면 함께 비교하면서 살펴보면 이해에 도움이 된다.

2. 애플케이션에서 구현할 프로퍼티/메서드 숙지

가이드를 읽어 대략 이해했으면, 참조 자료를 활용하여 구현할 기능에 필요한 프로퍼티와 메서드를 숙지한다.

3. 오류가 발생할 때도 문서 참고

OS 버전에 따라서 특정 동작을 하지 않거나 오류가 발생한다면 Deprecated된 기능을 사용하고 있지는 않은지 확인한다.

예제 : UITextField를 사용하는 경우

  1. Text Programming Guide for iOS 가이드 문서의 개요를 통해 UIKit 중 문자를 보여주거나 관리하는 주요 구성요소와 기능에 대해 살펴보고, UITextField 외에 문자를 다루는 다른 클래스(UITextLabel, UITextView)에는 무엇이 있는지도 함께 살펴보고 차이에 대해 이해한다.
  2. UITextField 참조 문서를 통해 기본적인 객체를 어떻게 생성할 수 있는지 알아본다.
  3. 텍스트 필드의 문자 색상/폰트/정렬 방법을 수정 하고 싶다면 프로퍼티 부분을 살펴본다.
  4. 텍스트 필드의 모양과 위치를 재정의하고 싶으면 메서드 부분을 살펴본다.
  5. 만약 원하는 프로퍼티나 메서드를 찾을 수 없다면 부모클래스의 문서로 이동하여 원하는 기능 찾기.
  6. 텍스트 필드에 특정 이벤트가 발생하는 것을 감지하고 싶다면 델리게이트가 있는지 살펴보고, 델리게이트가 있다면 해당 프로토콜 문서를 찾아가서 참조한다.