[#234] MyPageView 리팩터링

- Xcode markup 주석 작성
- 닉네임을 버튼에서 레이블로 변경

Author: jayn2u

EATSSU/App/Sources/Presentation/MyPage/View/MyPageView/MyPageView.swift

@@ -1,8 +1,8 @@
 //
 //  MyPageView.swift
-//  EatSSU-iOS
+//  EATSSU
 //
-//  Created by 최지우 on 2023/07/25.
+//  Edited by Jiwoong CHOI on 1/31/25.
 //
 
 import UIKit
@@ -12,79 +12,82 @@ import EATSSUDesign
 import SnapKit
 import Then
 
+/// `MyPageView`
+///
+/// 사용자 마이페이지 화면의 UI를 담당하는 뷰입니다.
+/// - 사용자 프로필 이미지, 닉네임, 계정 정보 등을 표시합니다.
+/// - 앱 버전 정보 및 회원 탈퇴 기능을 제공합니다.
+///
 final class MyPageView: BaseUIView {
     // MARK: - UI Components
 
-    /// MyPageView 전체 스크롤뷰
-    private let scrollView = UIScrollView()
+    /// **마이페이지 전체를 감싸는 스크롤 뷰**
+    let scrollView = UIScrollView()
 
-    /// 스크롤뷰 안에 들어갈 콘텐츠 뷰
-    private let contentView = UIView()
+    /// **스크롤 뷰 내부 콘텐츠 뷰**
+    let contentView = UIView()
 
-    // 사용자 이미지
-    var userImage = UIImageView().then {
+    /// **사용자 프로필 이미지**
+    let userImage = UIImageView().then {
         $0.image = EATSSUDesignAsset.Images.profile.image
     }
 
-    // 닉네임이 들어간 닉네임 변경 버튼
-    var userNicknameButton = UIButton().then {
-        $0.addTitleAttribute(
-            title: "다시 시도해주세요",
-            titleColor: .black,
-            fontName: EATSSUDesignFontFamily.Pretendard.regular.font(size: 16)
-        )
+    /// **사용자 닉네임 라벨**
+    let userNicknameLabel = UILabel().then {
+        $0.text = "다시 시도해주세요"
+        $0.font = EATSSUDesignFontFamily.Pretendard.regular.font(size: 16)
     }
 
-    // "연결된 계정" 레이블
+    /// **"연결된 계정" 라벨**
     let accountTitleLabel = UILabel().then {
         $0.text = ESTextLiteral.MyPage.linkedAccount
         $0.font = EATSSUDesignFontFamily.Pretendard.regular.font(size: 14)
     }
 
-    // 서버에서 계정 정보를 가져오기 전 기본값
-    var accountTypeLabel = UILabel().then {
+    /// **소셜 로그인 계정 유형 라벨 (초기값: "없음")**
+    let accountTypeLabel = UILabel().then {
         $0.text = "없음"
         $0.font = EATSSUDesignFontFamily.Pretendard.regular.font(size: 14)
-        $0.font = .bold(size: 14)
     }
 
-    // 소셜 로그인 공급업체 아이콘
-    var accountTypeImage = UIImageView()
+    /// **소셜 로그인 공급업체 아이콘**
+    let accountTypeImage = UIImageView()
 
-    lazy var totalAccountStackView = UIStackView(
-        arrangedSubviews: [accountTitleLabel, accountStackView]).then {
+    /// **"연결된 계정" 라벨과 계정 정보를 포함하는 수직 스택 뷰**
+    lazy var accountStackView = UIStackView(arrangedSubviews: [accountTypeLabel, accountTypeImage]).then {
         $0.alignment = .bottom
         $0.axis = .horizontal
-        $0.spacing = 20
+        $0.spacing = 5
     }
 
-    lazy var accountStackView = UIStackView(
-        arrangedSubviews: [accountTypeLabel, accountTypeImage]).then {
+    /// **"연결된 계정" 제목과 계정 정보를 포함하는 수평 스택 뷰**
+    lazy var totalAccountStackView = UIStackView(arrangedSubviews: [accountTitleLabel, accountStackView]).then {
         $0.alignment = .bottom
         $0.axis = .horizontal
-        $0.spacing = 5
+        $0.spacing = 20
     }
 
+    /// **마이페이지 목록 테이블 뷰**
     let myPageTableView = UITableView().then {
         $0.separatorStyle = .none
         $0.isScrollEnabled = false
     }
 
-    // "앱 버전" 레이블
-    private let appVersionStringLabel = UILabel().then { label in
-        label.text = ESTextLiteral.MyPage.appVersion
-        label.font = EATSSUDesignFontFamily.Pretendard.regular.font(size: 12)
-        label.textColor = EATSSUDesignAsset.Color.GrayScale.gray400.color
+    /// **앱 버전 정보 라벨**
+    let appVersionStringLabel = UILabel().then {
+        $0.text = ESTextLiteral.MyPage.appVersion
+        $0.font = EATSSUDesignFontFamily.Pretendard.regular.font(size: 12)
+        $0.textColor = EATSSUDesignAsset.Color.GrayScale.gray400.color
     }
 
-    // 현재 배포된 앱의 버전
-    private let appVersionLabel = UILabel().then { label in
-        label.text = MyPageRightItemData.version
-        label.font = EATSSUDesignFontFamily.Pretendard.regular.font(size: 12)
-        label.textColor = EATSSUDesignAsset.Color.GrayScale.gray400.color
+    /// **현재 앱 버전 표시 라벨**
+    let appVersionLabel = UILabel().then {
+        $0.text = MyPageRightItemData.version
+        $0.font = EATSSUDesignFontFamily.Pretendard.regular.font(size: 12)
+        $0.textColor = EATSSUDesignAsset.Color.GrayScale.gray400.color
     }
 
-    /// "탈퇴하기" 레이블과 탈퇴하기 아이콘
+    /// **회원 탈퇴 버튼 (아이콘 포함)**
     let userWithdrawButton: UIButton = {
         let button = UIButton()
         button.setTitle(ESTextLiteral.MyPage.withdraw, for: .normal)
@@ -95,30 +98,30 @@ final class MyPageView: BaseUIView {
         return button
     }()
 
-    /// "탈퇴하기" 레이블 underline
-    private let underLineView: UIView = {
+    /// **회원 탈퇴 버튼 아래에 표시되는 언더라인 뷰**
+    let underLineView: UIView = {
         let view = UIView()
         view.backgroundColor = EATSSUDesignAsset.Color.GrayScale.gray400.color
         return view
     }()
 
-    // MARK: - Intializer
+    // MARK: - Initializer
 
     override init(frame: CGRect) {
         super.init(frame: frame)
-
         registerTableViewCells()
     }
 
-    // MARK: - Functions
+    // MARK: - UI 설정
 
+    /// UI 구성 요소를 화면에 추가합니다.
     override func configureUI() {
         addSubview(scrollView)
         scrollView.addSubview(contentView)
 
         contentView.addSubviews(
             userImage,
-            userNicknameButton,
+            userNicknameLabel,
             totalAccountStackView,
             myPageTableView,
             appVersionStringLabel,
@@ -128,6 +131,7 @@ final class MyPageView: BaseUIView {
         )
     }
 
+    /// UI 레이아웃을 설정합니다.
     override func setLayout() {
         scrollView.snp.makeConstraints {
             $0.edges.equalToSuperview()
@@ -144,15 +148,15 @@ final class MyPageView: BaseUIView {
             $0.height.width.equalTo(100)
         }
 
-        userNicknameButton.snp.makeConstraints {
+        userNicknameLabel.snp.makeConstraints {
             $0.top.equalTo(userImage.snp.bottom).offset(6)
             $0.centerX.equalTo(userImage)
             $0.height.equalTo(40)
         }
 
         totalAccountStackView.snp.makeConstraints {
             $0.centerX.equalToSuperview()
-            $0.top.equalTo(userNicknameButton.snp.bottom).offset(10)
+            $0.top.equalTo(userNicknameLabel.snp.bottom).offset(10)
         }
 
         myPageTableView.snp.makeConstraints {
@@ -162,21 +166,20 @@ final class MyPageView: BaseUIView {
             $0.width.equalToSuperview()
         }
 
-        appVersionStringLabel.snp.makeConstraints { make in
-            make.top.equalTo(myPageTableView.snp.bottom).offset(6)
-            make.leading.equalToSuperview().inset(24)
+        appVersionStringLabel.snp.makeConstraints {
+            $0.top.equalTo(myPageTableView.snp.bottom).offset(6)
+            $0.leading.equalToSuperview().inset(24)
         }
 
-        appVersionLabel.snp.makeConstraints { make in
-            make.top.equalTo(myPageTableView.snp.bottom).offset(6)
-            make.trailing.equalToSuperview().inset(24)
+        appVersionLabel.snp.makeConstraints {
+            $0.top.equalTo(myPageTableView.snp.bottom).offset(6)
+            $0.trailing.equalToSuperview().inset(24)
         }
 
-        // TODO: withdrawStackView를 프로퍼티로 선언할 때, lazy를 사용하면 레이아웃이 한 타임 늦게 잡히는 문제로 인해서 여기에서 스택 안에 들어갈 뷰를 추가함. 개선 방법이 없는지 확인.
-        userWithdrawButton.snp.makeConstraints { make in
-            make.top.equalTo(appVersionLabel.snp.bottom).offset(16)
-            make.trailing.equalToSuperview().inset(24)
-            make.bottom.equalToSuperview().inset(70)
+        userWithdrawButton.snp.makeConstraints {
+            $0.top.equalTo(appVersionLabel.snp.bottom).offset(16)
+            $0.trailing.equalToSuperview().inset(24)
+            $0.bottom.equalToSuperview().inset(70)
         }
 
         underLineView.snp.makeConstraints {
@@ -186,23 +189,21 @@ final class MyPageView: BaseUIView {
         }
     }
 
-    private func registerTableViewCells() {
-        myPageTableView.register(
-            MyPageTableDefaultCell.self,
-            forCellReuseIdentifier: MyPageTableDefaultCell.identifier
-        )
-        myPageTableView.register(
-            NotificationSettingTableViewCell.self,
-            forCellReuseIdentifier: NotificationSettingTableViewCell.identifier
-        )
+    // MARK: - 기능
+
+    /// 마이페이지 테이블 뷰의 셀을 등록합니다.
+    func registerTableViewCells() {
+        myPageTableView.register(MyPageTableDefaultCell.self, forCellReuseIdentifier: MyPageTableDefaultCell.identifier)
+        myPageTableView.register(NotificationSettingTableViewCell.self, forCellReuseIdentifier: NotificationSettingTableViewCell.identifier)
     }
 
-    public func setUserInfo(nickname: String) {
-        userNicknameButton.addTitleAttribute(
-            title: "\(nickname)  >",
-            titleColor: .black,
-            fontName: .semiBold(size: 20)
-        )
+    /// 사용자 정보를 설정합니다.
+    ///
+    /// - Parameter nickname: 사용자 닉네임
+    func setUserInfo(nickname: String) {
+        userNicknameLabel.text = nickname
+        userNicknameLabel.font = EATSSUDesignFontFamily.Pretendard.semiBold.font(size: 20)
+
         if let accountType = UserInfoManager.shared.getCurrentUserInfo()?.accountType {
             switch accountType {
             case .apple:

EATSSU/App/Sources/Presentation/MyPage/ViewController/MyPageViewController.swift

@@ -105,24 +105,12 @@ final class MyPageViewController: BaseViewController {
 
     /// - Note: 버튼들의 액션을 연결합니다.
     override func setButtonEvent() {
-        mypageView.userNicknameButton
-            .addTarget(self, action: #selector(didTappedChangeNicknameButton), for: .touchUpInside)
-
         mypageView.userWithdrawButton
             .addTarget(self, action: #selector(userWithdrawButtonTapped), for: .touchUpInside)
     }
 
     // MARK: - Actions
 
-    //======================================================================
-    /// - Note: 닉네임 변경 버튼을 탭했을 때 호출됩니다.
-    ///         닉네임 설정 화면으로 이동합니다.
-    @objc
-    private func didTappedChangeNicknameButton() {
-        let setNickNameVC = SetNickNameViewController()
-        navigationController?.pushViewController(setNickNameVC, animated: true)
-    }
-
     /// - Note: 회원탈퇴 버튼을 탭했을 때 호출됩니다.
     ///         회원탈퇴 화면으로 이동합니다.
     @objc