43. [SwiftUI] 마크업, 문서화 (코드 정리)

본인이 알아보기 위해서 or 협업을 위해 주석처을 사용하는 경우가 많다.

단순한 백슬래시 두 개를 활용한 // 뿐만 아니라 좀 더 코드를 체계적으로 관리할 수 있는 방법을 알아보자.

//기본 주석

 

 /*

멀티라인 주석

*/ 

 

마크업 주석

코드 섹션 분리를 위해 사용. 미니맵에 표시됨.

// MARK: ~~

미니맵(에디터 옵션에서 활성화)

코드 폴딩 ( ... 되어 있는 블록)

긴 코드를 접어둘 수 있다. 더블클릭하면 펼쳐짐

접는 방법

option + command + leftArrow 

펼치는 방법 

option + command + rightArrow OR 더블클릭

 

코드 관련 설명이 길 때, 혹은 자신의 업무를 기록해 둘 때 유용해 보인다.

 

DOCUMENTATION

함수, 변수 등을 option을 누른 채로 보면 관련 정보가 뜨는 것을 본 적이 있을 것이다.

 

기본적으로 ///만 쓰면 Summary

줄을 띄우고 더 작성하면 Discussion

예시 실행문은 ``` ~~ ```

이외 경고, 파라미터, 리턴에 대한 설명도 추가할 수 있다.

복잡한 함수, 변수 등을 만들고 팀원에게 설명할 필요가 있을 때 유용해 보인다.

 

 

DEPRECATED

+ 간단한 알럿을 추가했는데 기존에 쓰던 코드가 deprecated 된 코드여서 다른 방식으로 구현하는 것이 좋아 보인다.

                .alert("ALERT", isPresented: $showAlert, actions: {
                    Button("OK", role: .cancel) {}
            })

//알럿 예시코드

 

+ 네비게이션바 아이템도 마찬가지. 

                .toolbar {
                    ToolbarItem(placement: .navigationBarTrailing, content: {
                        Button("ALERT", action: {
                            showAlert.toggle()
                        })
                    })
                }
// .toolbar 활용
// 좀 더 확장성이 좋아진 거 같다.