Swift/Swift GuideLines

읽기 좋은 코드 작성하기 - Fundamentals

728x90

읽기 좋은 코드 작성하기 - Swift API Design Guidelines

 

iOS를 처음에는 Storyboard로 개발했는데 코드가 관리가 안되고, 조금 구현하기 어렵다 싶으면 왠만하면 programmatically 코드로 작성이되어서 programmatically로 전부 갈아엎었다..

 

이제 리팩토링을 어떻게 해야할까 리팩토링을 어떻게 해야할까 고민하던 와중에 찾은 강의다. 

 

읽기 좋은 코드 작성하기 - Swift API Design Guidelines - 인프런 | 강의

이 강의를 통해 이해하기 쉬운 코드가 무엇인지 제대로 된 기준을 잡을 수 있습니다. 단기간에 코드 컨벤션에 관한 많은 노하우를 배울 수 있을 것입니다., - 강의 소개 | 인프런...

www.inflearn.com

총강의 시간은 1시간 28분으로 짧다. 코드에 대한 이해가 있다면 강사가 정리해놓은 github만으로 충분히 이해 할 수 있을 것 같다.

 

지금 복잡하게 얽혀진 코드에 실제로 적용하려면 굉장히 힘들 것 같은데,, 

우선 정리를 해야 리팩토링을 하던지 말던지 할 것같아서 블로그에 정리를 진행 할 예정이다.

 

해당강의에서 

강의자료는 https://cozzin.gitbook.io/swift-api-design-guidelines/ 에 있습니다.

깃헙 레포지토리는 https://github.com/cozzin/swift-api-design-guidelines 입니다.

 

Fundamentals (기본)

  • 사용하는 쪽에서 명확하다고 느끼게 하는 것이 중요한 목표다.
  • 명확한 것이 간결한 것보다 중요하다. Swift 코드를 압축적으로 표현할 수 있긴 하지만, 가장 짧은 코드를 작성하는게 목표가 아니다.
  • 모든 선언에 대해 문서 주석을 작성하세요. ( 강사는 모든선언에 주석으로 설명할 필요는 없다고 생각 한다. 아마 외부에 공개하는 모듈의 경우 해당 API를 설명하는 주석이 필요하다고 하는 것 같다고 합니다.)

 

반응형