🚭 👩🏾‍🔬 🙇🏽 आईओएस विकास में कोड पठनीयता बढ़ाना 🌱 👨‍❤️‍👨 🥨

एक ऐसी पुस्तक की कल्पना करें जिसमें अध्याय में कोई विभाजन नहीं है, और सब कुछ तार्किक और शब्दार्थ के बिना टूटने के बिना चला जाता है, एक ऐसी पुस्तक जहां कोई पैराग्राफ नहीं हैं, कोई डॉट्स और कॉमा नहीं हैं, एक पुस्तक जहां पहली पंक्ति एक चीज़ के बारे में बताती है, दूसरी दूसरी के बारे में, तीसरी फिर के बारे में। पहली बात।

प्रस्तुत?

क्या आप समझ सकते हैं कि किताब किस बारे में है?

आप कितनी तेजी से उस मार्ग को पा सकते हैं जिसमें आप रुचि रखते हैं?

आपके कोड, साथ ही पुस्तक की सामग्री को संरचित करने की आवश्यकता है ताकि कोड को पढ़ने में आसान हो और इसमें अर्थ को व्यक्त किया जा सके।

इस लेख में मैं कोड के आयोजन के उदाहरण दिखाऊंगा जिसमें कक्षाओं में मुख्य ब्लॉक और उनके टूटने का क्रम समान होगा।

सुविधा के लिए, मैं शब्द वर्ग (क्लास) का उपयोग करूंगा, लेकिन किसी भी प्रकार के प्रकार (क्लास, स्ट्रक्चर, एनम) का अर्थ है।

इन युक्तियों के आवेदन के लिए धन्यवाद, आपका कोड पठनीय हो जाएगा, जो भविष्य में इसके साथ काम की सुविधा और गति प्रदान करेगा।

बेशक, वर्णित सुझावों को मूल सिद्धांतों का पालन करते हुए, अपनी पसंद के अनुसार अपग्रेड किया जा सकता है।

पहले, एक ही कोड की दो तरह से तुलना करते हैं।

एक गन्दा वर्ग का एक उदाहरण:

final class MessyViewController: UIViewController {
private let userService = UserService()
var userID: String?
private var userList: [User]?
@IBOutlet private weak var searchBar: UISearchBar!
weak var delegate: SomeDelegate?
@IBAction private func cancelButtonPressed(_ sender: UIBarButtonItem) {
dismiss(animated: true, completion: nil)
}
override func viewDidLoad() {
super.viewDidLoad()
// Do any additional setup after loading the view.
navigationController?.navigationBar.backgroundColor = .red
navigationItem.title = "Some"
}
@IBOutlet private weak var tableView: UITableView!
}

view raw MessyViewController.swift hosted with ❤ by GitHub

यह कोड विधियों, चर और आउटलेट के डंप के समान है, जिसमें सब कुछ एक साथ विलीन हो जाता है, यह समझना मुश्किल है कि यह क्या संदर्भित करता है और किस स्थान पर क्या देखना है।

शुद्ध वर्ग का एक उदाहरण:

final class CleanViewController: UIViewController {
// MARK: - IBOutlets
@IBOutlet private weak var searchBar: UISearchBar!
@IBOutlet private weak var tableView: UITableView!
// MARK: - Public Properties
var userID: String?
weak var delegate: SomeDelegate?
// MARK: - Private Properties
private let userService = UserService()
private var userList: [User]?
// MARK: - Lifecycle
override func viewDidLoad() {
super.viewDidLoad()
setupNavigationBar()
}
// MARK: - Private Methods
private func setupNavigationBar() {
navigationController?.navigationBar.backgroundColor = .red
navigationItem.title = "Some"
}
// MARK: - IBActions
@IBAction private func cancelButtonPressed(_ sender: UIBarButtonItem) {
dismiss(animated: true, completion: nil)
}
}

view raw CleanViewController.swift hosted with ❤ by GitHub

खाली लाइन 38 - अंतिम विधि से एक पंक्ति को इंडेंट करें ताकि आप देख सकें कि विधि का अंतिम समापन ब्रैकेट कहाँ समाप्त होता है और कक्षा कहाँ समाप्त होती है।

समान कार्यक्षमता को दोनों उदाहरणों में दिखाया गया है, लेकिन अंतर यह है कि दूसरे विकल्प में एक स्पष्ट संरचना है, जिसके कारण तर्क अधिक स्पष्ट है, कोड को पढ़ना आसान है, आप जल्दी से पा सकते हैं कि आप इसमें क्या ढूंढ रहे हैं, और इसके अलावा, इसे देखना सिर्फ अच्छा है।

शुद्ध वर्ग संरचना के निर्माण के लिए बुनियादी सिद्धांत:

हमेशा इस्तेमाल करें // MARK: -
लेबल के नाम दें और उनकी प्राथमिकता निर्धारित करें
जीवन चक्र विधियों में से तर्क को अलग-अलग तरीकों से रखना
हम प्रोटोकॉल को लागू करने के लिए एक्सटेंशन का उपयोग करते हैं
तार्किक रूप से संबंधित तत्वों का चयन करें
हम अप्रयुक्त को हटा दें
स्वचालित दिनचर्या

1. हमेशा इस्तेमाल करें // MARK: -

पढ़ने में आसानी के लिए, पुस्तक को अध्यायों में विभाजित किया गया है, और यह हमारे लिए काम करने के लिए अधिक आरामदायक होगा यदि हम // MARK: - का उपयोग करके सामग्री की एक वर्ग तालिका बनाते हैं।

यह लेबल न केवल पूरे कोड से अच्छी तरह से बाहर खड़ा है, बल्कि स्वचालित रूप से सामग्री की तालिका भी बनाता है - यह कोड में इस फ़ाइल के तत्वों की सूची में बोल्ड में हाइलाइट करता है।

आप इस फ़ाइल या ctr + 6 (दस्तावेज़ आइटम मेनू) के नाम के बाद फ़ाइल के बहुत ऊपर दाहिने तीर (>) के बाद बटन पर क्लिक करके किसी फ़ाइल की सामग्री की तालिका देख सकते हैं।

2. हम लेबल के नाम देते हैं और हम उनके अनुक्रम को स्थापित करते हैं

नीचे तार्किक रूप से जुड़े ब्लॉक और उनके अनुक्रम में कोड को तोड़ने के लिए मुख्य लेबल हैं:

// MARK: - IBOutlets
// MARK: - Public Properties
// MARK: - Private Properties
// MARK: - Initializers
// MARK: - Lifecycle
// MARK: - Public Methods
// MARK: - Private Methods
// MARK: - IBActions

view raw MarkList.swift hosted with ❤ by GitHub

इस समूहीकरण विधि का उपयोग करते समय, कोई भी आसानी से किसी भी वर्ग के कोड में नेविगेट कर सकता है।

3. अलग-अलग तरीकों से जीवन चक्र विधियों से तर्क को बाहर निकालें

ViewController के जीवनचक्र विधियों के अंदर के तर्क को अलग-अलग तरीकों में रखा जाना चाहिए, भले ही आपको एक पंक्ति की कोड वाली विधि बनानी पड़े। आज एक है, और कल दस है।

❌ NOT Preferred
override func viewDidLoad() {
super.viewDidLoad()
navigationController?.navigationBar.backgroundColor = .red
someButton.layer.cornerRadius = 10
someButton.layer.masksToBounds = true
navigationItem.title = "Some"
print("Some")
}
✅ Preferred
// MARK: - Lifecycle
override func viewDidLoad() {
super.viewDidLoad()
setupNavigationBar()
setupSomeButton()
printSome()
}
// MARK: - Private Methods
private func setupNavigationBar() {
navigationController?.navigationBar.backgroundColor = .red
navigationItem.title = "Some"
}
private func setupSomeButton() {
someButton.layer.cornerRadius = 10
someButton.layer.masksToBounds = true
}
private func printSome() {
print("Some")
}

view raw LifecycleMethods.swift hosted with ❤ by GitHub

इस तथ्य के कारण कि कार्यान्वयन विवरण तीसरे पक्ष के तरीकों से आउटसोर्स किए जाते हैं, जीवन चक्र का तर्क स्पष्ट हो जाता है।

4. प्रोटोकॉल को लागू करने के लिए विस्तार का उपयोग करें

चिह्नित / विस्तार में प्रोटोकॉल कार्यान्वयन को बाहर ले जाएं : मार्क: - SomeProtocol :

❌ NOT Preferred
final class CleanViewController: UIViewController, UITableViewDataSource, UITableViewDelegate {
// all methods
}
✅ Preferred
final class CleanViewController: UIViewController {
// class stuff here
}
// MARK: - Table View Data Source
extension CleanViewController: UITableViewDataSource {
func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
return userList?.count ?? 0
}
func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
let cell = UITableViewCell()
return cell
}
}

view raw extension.swift hosted with ❤ by GitHub

इस लेबल में इस प्रोटोकॉल से संबंधित सब कुछ होगा - वह सब कुछ जो केवल यहाँ है और कहीं और जाने की आवश्यकता नहीं है, अन्यथा प्रोटोकॉल के तरीके और गुण पूरे वर्ग में बिखरे रहेंगे।

5. तार्किक रूप से संबंधित तत्वों का चयन करें

दृश्यता बढ़ाने के लिए, खाली लाइन का उपयोग करके तार्किक रूप से संबंधित तत्वों का चयन करना आवश्यक है:

❌ NOT Preferred
private func showActivityIndicator(on viewController: UIViewController) {
activityIndicator.center = viewController.view.center
loadingView.backgroundColor = #colorLiteral(red: 0, green: 0, blue: 0, alpha: 1)
loadingView.alpha = 0.5
activityIndicator.hidesWhenStopped = true
activityIndicator.style = .whiteLarge
loadingView.center = viewController.view.center
loadingView.clipsToBounds = true
loadingView.layer.cornerRadius = 15
viewController.view.addSubview(loadingView)
viewController.view.addSubview(activityIndicator)
activityIndicator.startAnimating()
}
✅ Preferred
private func showActivityIndicator(on viewController: UIViewController) {
activityIndicator.center = viewController.view.center
activityIndicator.hidesWhenStopped = true
activityIndicator.style = .whiteLarge
loadingView.center = viewController.view.center
loadingView.backgroundColor = #colorLiteral(red: 0, green: 0, blue: 0, alpha: 1)
loadingView.alpha = 0.5
loadingView.clipsToBounds = true
loadingView.layer.cornerRadius = 15
viewController.view.addSubview(loadingView)
viewController.view.addSubview(activityIndicator)
activityIndicator.startAnimating()
}

view raw LogicalBlocks.swift hosted with ❤ by GitHub

6. हम अप्रयुक्त को हटा दें

अनावश्यक टिप्पणियों (डिफ़ॉल्ट), खाली विधियों या मृत कार्यक्षमता को न छोड़ें - इससे कोड बंद हो जाता है। AppDelegate वर्ग पर ध्यान दें, सबसे अधिक संभावना है कि आप अंदर टिप्पणी के साथ खाली तरीके पाएंगे।

❌ NOT Preferred
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
func application(
_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
// Override point for customization after application launch.
return true
}
//
// func someFunc() {
// print("Some")
// }
func applicationWillResignActive(_ application: UIApplication) {
// Sent when the application is about to move from active to inactive state. This can occur for certain
//types of temporary interruptions (such as an incoming phone call or SMS message) or when the user quits
//the application and it begins the transition to the background state.
// Use this method to pause ongoing tasks, disable timers, and invalidate graphics rendering callbacks. Games should use this method to pause the game.
}
✅ Preferred
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
func application(
_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
return true
}
}

view raw AppDelegate.swift hosted with ❤ by GitHub

7. स्वचालित दिनचर्या

प्रत्येक कक्षा में मैन्युअल रूप से लिखने से बचने के लिए // MARK: - SomeMark , कोड स्निपेट का उपयोग करें।

हम एक लेबल लिखते हैं, इसे चुनें, फिर संपादक -> कोड स्निपेट बनाएं, इसे एक नाम दें और इसे शॉर्टकट कहें।

// MARK: - बोनस

अंतिम कीवर्ड के साथ वर्ग को चिह्नित करें यदि इस वर्ग के बच्चे नहीं हैं - परियोजना तेजी से संकलन करती है और कोड तेजी से चलता है।
निजी कीवर्ड के साथ गुण, आउटलेट और विधियों को चिह्नित करें - वे केवल कक्षा के अंदर उपलब्ध होंगे और यदि आवश्यक नहीं हैं, तो वे गुणों और विधियों की सार्वजनिक सूची में नहीं होंगे।

मैं आपको आवेदन विकास में हर सफलता की कामना करता हूं और अपनी कक्षा को साफ-सुथरा होने दूंगा!

// MARK: - एक लेख लिखने में मदद करें
सर्गेई पेचेलाकोव
एलेक्सी प्लाशकोव एलेक्सेपलेशकोव

// मार्क: - लिंक
रे वेंडरलिच कोड शैली

	final class MessyViewController: UIViewController {

	private let userService = UserService()
	var userID: String?
	private var userList: [User]?

	@IBOutlet private weak var searchBar: UISearchBar!

	weak var delegate: SomeDelegate?

	@IBAction private func cancelButtonPressed(_ sender: UIBarButtonItem) {
	dismiss(animated: true, completion: nil)
	}

	override func viewDidLoad() {
	super.viewDidLoad()
	// Do any additional setup after loading the view.
	navigationController?.navigationBar.backgroundColor = .red
	navigationItem.title = "Some"
	}
	@IBOutlet private weak var tableView: UITableView!
	}

	final class CleanViewController: UIViewController {

	// MARK: - IBOutlets

	@IBOutlet private weak var searchBar: UISearchBar!
	@IBOutlet private weak var tableView: UITableView!

	// MARK: - Public Properties

	var userID: String?
	weak var delegate: SomeDelegate?

	// MARK: - Private Properties

	private let userService = UserService()
	private var userList: [User]?

	// MARK: - Lifecycle

	override func viewDidLoad() {
	super.viewDidLoad()

	setupNavigationBar()
	}

	// MARK: - Private Methods

	private func setupNavigationBar() {
	navigationController?.navigationBar.backgroundColor = .red
	navigationItem.title = "Some"
	}

	// MARK: - IBActions

	@IBAction private func cancelButtonPressed(_ sender: UIBarButtonItem) {
	dismiss(animated: true, completion: nil)
	}

	}

	❌ NOT Preferred

	override func viewDidLoad() {
	super.viewDidLoad()

	navigationController?.navigationBar.backgroundColor = .red
	someButton.layer.cornerRadius = 10
	someButton.layer.masksToBounds = true
	navigationItem.title = "Some"
	print("Some")
	}


	✅ Preferred

	// MARK: - Lifecycle

	override func viewDidLoad() {
	super.viewDidLoad()

	setupNavigationBar()
	setupSomeButton()
	printSome()
	}


	// MARK: - Private Methods

	private func setupNavigationBar() {
	navigationController?.navigationBar.backgroundColor = .red
	navigationItem.title = "Some"
	}

	private func setupSomeButton() {
	someButton.layer.cornerRadius = 10
	someButton.layer.masksToBounds = true
	}

	private func printSome() {
	print("Some")
	}

	❌ NOT Preferred

	final class CleanViewController: UIViewController, UITableViewDataSource, UITableViewDelegate {

	// all methods
	}


	✅ Preferred

	final class CleanViewController: UIViewController {

	// class stuff here

	}


	// MARK: - Table View Data Source
	extension CleanViewController: UITableViewDataSource {

	func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {

	return userList?.count ?? 0
	}

	func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {

	let cell = UITableViewCell()
	return cell
	}

	}

	❌ NOT Preferred

	private func showActivityIndicator(on viewController: UIViewController) {
	activityIndicator.center = viewController.view.center
	loadingView.backgroundColor = #colorLiteral(red: 0, green: 0, blue: 0, alpha: 1)
	loadingView.alpha = 0.5
	activityIndicator.hidesWhenStopped = true
	activityIndicator.style = .whiteLarge
	loadingView.center = viewController.view.center
	loadingView.clipsToBounds = true
	loadingView.layer.cornerRadius = 15
	viewController.view.addSubview(loadingView)
	viewController.view.addSubview(activityIndicator)
	activityIndicator.startAnimating()
	}


	✅ Preferred

	private func showActivityIndicator(on viewController: UIViewController) {
	activityIndicator.center = viewController.view.center
	activityIndicator.hidesWhenStopped = true
	activityIndicator.style = .whiteLarge

	loadingView.center = viewController.view.center
	loadingView.backgroundColor = #colorLiteral(red: 0, green: 0, blue: 0, alpha: 1)
	loadingView.alpha = 0.5
	loadingView.clipsToBounds = true
	loadingView.layer.cornerRadius = 15

	viewController.view.addSubview(loadingView)
	viewController.view.addSubview(activityIndicator)

	activityIndicator.startAnimating()
	}

	❌ NOT Preferred

	@UIApplicationMain
	class AppDelegate: UIResponder, UIApplicationDelegate {

	var window: UIWindow?


	func application(
	_ application: UIApplication,
	didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
	// Override point for customization after application launch.
	return true
	}
	//
	// func someFunc() {
	// print("Some")
	// }

	func applicationWillResignActive(_ application: UIApplication) {
	// Sent when the application is about to move from active to inactive state. This can occur for certain
	//types of temporary interruptions (such as an incoming phone call or SMS message) or when the user quits
	//the application and it begins the transition to the background state.
	// Use this method to pause ongoing tasks, disable timers, and invalidate graphics rendering callbacks. Games should use this method to pause the game.
	}


	✅ Preferred

	@UIApplicationMain
	class AppDelegate: UIResponder, UIApplicationDelegate {

	var window: UIWindow?


	func application(
	_ application: UIApplication,
	didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

	return true
	}

	}

आईओएस विकास में कोड पठनीयता बढ़ाना