모든 언어나 프레임워크에는 공식 문서가 존재한다.

api docs1

api docs2

API Docs라고 부르는 것이다.

하지만 처음부터 API Docs를 보고 이해하기는 어렵다. 더군다나 저 방대한 API Docs에서 내가 원하는 것을 정확히 찾기는 더더욱 어렵고, 같은 프로그래밍을 하더라도 여러 방법의 구현이 가능하다.

그렇다면 어떻게 하는 것이 좋을까? 🤔

five steps to coding

  1. Google 검색하기
  2. StackOverflow 에서 답변 구하기
  3. 코드 구현하기
  4. 문서에서 코드가 의미하는 바를 찾기
  5. 필요에 따라 코드를 커스터마이징하기

1. Google 검색하기

how to search on google

  1. 내 앱이 무엇을 하기를 원하는지
  2. 프로그래밍 언어
  3. 어떤 리소스가 필요한지

Play sound Swift StackOverflow

2. StackOverflow 에서 답변 구하기

  1. 글 작성자의 질문이 내 질문과 일치하는가
  2. 답변이 내가 찾고자 하는 답변이 맞는가
    • 답변 선택에는 유저들의 평가, 질문자의 답안 채택을 참고할 수 있다.
    • 상위 하나의 답변만 확인하지 말고, 상위 답변 3개를 같이 확인한다.
    • 얼마나 최신 답변인지, 내 버전에서도 작동 하는가에 따라 우선 순위를 둘 수 있다.

3. 코드 구현하기

StackOverflow 코드를 복사해와 프로젝트에 붙여넣고, 변수명 등을 고쳐 작동시켜본다.

4. 문서에서 코드가 의비하는 바를 찾기

apple docs

드디어 API Docs 를 활용할 차례다.

문서를 보고 코드가 의미하는 것, 어떻게 작동하는지를 파악한다.

5. 필요에 따라 코드를 커스터마이징하기

이제 문서를 통해 코드를 좀 더 깊게 이해했다면, 내 앱의 필요에 맞게 코드를 커스터마이징한다.




Reference

  1. Angela Yu, “Using and Understanding Apple Documentation, Section 7.” Udemy.com. last modified Nov. 2021, https://www.udemy.com/course/ios-13-app-development-bootcamp/.