swift.org3 [iOS] 변수명, 어떻게 지을까? - API Design Guideline(3) Conventions General Conventions ( 일반 규칙 ) 1. 시간복잡도가 O(1)이 아닌 모든 연산프로퍼티(any computed property)의 복잡도를 문서화한다. 사람들은 종종 mental model로서 Property를 저장했기에, Property 접근에 연산이 중요하지 않다고 생각하는 경우가 있다. 이는 잘못된 생각이다. Document the complexity of any computed property that is not O(1). People often assume that property access involves no significant computation, because they have stored properties as a mental model... 2023. 3. 28. [iOS] 변수명, 어떻게 지을까? - API Design Guideline(2) Naming Promote Clear Usage ( 명확한 사용을 추구해라. ) 1. 코드를 읽는 사람을 위해 의미가 모호하지 않도록 필요한 모든 단어를 포함시켜라. Include all the words needed to avoid ambiguity for a person reading code where the name is used. For example, consider a method that removes the element at a given position within a collection. /// - Note: 좋은 예 extension List { public mutating func remove(at position: Index) -> Element } employees.remov.. 2023. 3. 28. [iOS] 변수명, 어떻게 지을까? - API Design Guideline(1) API Design Guideline의 원문과 번역본이 별도로 있지만, 단순히 읽기만 하면 잘 이해가 안 되더라도 그냥 넘어가거나 번역이 이상하면 눈에 들어오지 않아 나름대로 번역을 해봤다. 번역이라고 번역투이고 싶지 않아서 자연스럽게 써보고 싶었는데 뭔가 잘 안 되는 것이 아쉽긴하다. (번역이 이상하다는 말을 반성하게 됨.) 의역된 부분이 다소 있기에 불편하게 보는 사람들이 있을지도 모르겠다. 작성하고보니 전부 읽는 건 나중에 보게 될 나에게도 부담스러울 것 같아, 글을 3개로 나눴다. Fundamentals ( 기본사항 ) 사용 시점의 명확성이 가장 중요하다. 단순히 선언된 코드를 읽지 말고, 사용 사례를 생각하며 문맥상 명확한지 확인해라. Clarity at the point of use is yo.. 2023. 3. 28. 이전 1 다음