Xcode Mark Line 을 활용하여 코드 가독성 향상 시키기

www.avanderlee.com/xcode/xcode-mark-line-comment/

Xcode Mark Line to improve readability using // Mark: comments

위 글을 보고 제 맘대로 번역한 글 입니다.

 

 

---

 

 

 

Mark line은 챕터에 제목을 넣거나 라인을 추가하여

클래스 또는 구조체 코드에 대한 보다 나은 overview를 제공합니다.

이 테크닉은 특정 메서드를 찾거나 수정이 필요한 사항을 표시할 때 유용하게 쓰일 수 있습니다.

 

 

 

Mark Comment를 사용하기 전에 한번 더 생각해야 하는 이유

 

mark Comment가 필요하다는 것은 당신의 class 또는 struct가 너무 크다는 것입니다.

이것은 당신이 너무 많은 동작을 담고 있는 instance를 작성했다는 것을 의미합니다.

 

이 경우 당신의 코드에 대해서 다시 한번 생각하고 instance를 분리시킬 수 없을지 생각해봐야 합니다.

적은 코드가 보통을 가독성이 높습니다.

 

몇몇의 경우, 많은 양의 코드가 불가피한 경우가 있습니다.

viewController가 많은 protocol을 채택하고 있는 경우가 그렇습니다.

이런 경우 Mark comment를 통해서 코드 가독성을 향상시킬 수 있습니다.

 

 

 

// MARK:

method navigator에서 chapter에 대한 title을 만들어 줍니다.

// MARK: UICollectionViewDelegate

 

https://www.avanderlee.com/xcode/xcode-mark-line-comment/

 

// MARK:-

method navigator에서 구분선을 만들어 줍니다.

// MARK:- header1  과 같이 쓰면 구분선과 함께 title도 생성합니다.

// MARK:- UICollectionView methods

https://www.avanderlee.com/xcode/xcode-mark-line-comment/

 

// FIXME:

 

이 mark를 사용하면 밴드 모양의 아이콘이 출력됩니다.

#warning과 함께 사용한다면 당신이 이것을 좀 더 빠르게 수정하게 만들 것 입니다.

func collectionView(...){
    // FIXME: Use the view model for this number
    #warning("Use the view model for this number.")
    
    return 10
}

https://www.avanderlee.com/xcode/xcode-mark-line-comment/

 

 

// TODO:

 

// FIXME: 와 유사한 기능의 mark 입니다.

무엇을 사용하는지는 당신에게 달려있지만 // FIXME: 마크가 좀 더 시각적으로 더 좋은 것 같습니다.

 

 

 

 

나만의 결론

 

1. mark 의 - 이 구분선인 것을 처음 알았습니다.

2. fixme도 처음 알 았는데 todo 보다 좋은 것 같습니다.

3. #warning도 함께