आपके कोड से बदबू आ रही है क्योंकि ऐसे कई उदाहरण हैं जहां इसे संपादित या बेहतर किया जा सकता है।

इनमें से अधिकतर गंधें किसी ऐसी चीज़ का संकेत मात्र होती हैं जो गलत हो सकती है। इसलिए, उन्हें स्वयं ठीक करने की आवश्यकता नहीं है... (हालांकि, आपको इस पर गौर करना चाहिए।)

पिछला कोड गंध

आप पिछले सभी कोड स्मेल (भाग I - XLV) यहां पा सकते हैं।

आगे है...

कोड गंध 226 - मिश्रित प्राथमिकताएँ

एक और दुर्घटनाग्रस्त अंतरिक्ष यान. एक अन्य सॉफ़्टवेयर समस्या

टीएल;डीआर: सॉफ़्टवेयर डिज़ाइन और परीक्षण करें। यह हार्डवेयर से सस्ता है

समस्या

• विक्षेपण दोष
• अप्रत्याशित दोष

समाधान

1. सटीक सिमुलेशन बनाएं
2. दोष-सहिष्णु सॉफ़्टवेयर बनाएं

प्रसंग

लूना-25 19 अगस्त 2023 को चंद्रमा की सतह पर दुर्घटनाग्रस्त हो गया।

भारत का चंद्रयान-3 चंद्रमा के दक्षिणी ध्रुव पर 4 दिन पहले सॉफ्ट लैंडिंग करेगा।

एक फोरेंसिक विश्लेषण से पता चला कि निर्देश एक बस साझा करते थे और उन्हें सही ढंग से प्राथमिकता नहीं दी गई थी।

अंतरिक्षयानों में सॉफ़्टवेयर दोषों का एक लंबा इतिहास है।

नमूना कोड

गलत

 class TaskManager: def __init__(self): self.tasks = [] def add_task(self, task, priority): self.tasks.append((task, priority)) def execute_tasks(self): # No sorting for task, _ in self.tasks: task.execute() class Task: def __init__(self, name): self.name = name def execute(self): print(f"Executing task: {self.name}") task_manager = TaskManager() highPriorityTask = Task("Slow down") mediumPriorityTask = Task("Take Photos") reviveKlaatu = Task("Klaatu barada nikto") # unsorted task_manager.add_task(mediumPriorityTask, 2) task_manager.add_task(highPriorityTask, 1) task_manager.add_task(reviveKlaatu, 3) task_manager.execute_tasks()

सही

 class TaskManager: def __init__(self): self.tasks = [] def add_task(self, task, priority): self.tasks.append((task, priority)) def execute_tasks(self): # Sort tasks by priority (high to low) self.tasks.sort(key=lambda x: x[1], reverse=True) for task, _ in self.tasks: task.execute() class Task: def __init__(self, name): self.name = name def execute(self): print(f"Executing task: {self.name}") task_manager = TaskManager() highPriorityTask = Task("Slow down") mediumPriorityTask = Task("Take Photos") reviveKlaatu = Task("Klaatu barada nikto") # unsorted task_manager.add_task(mediumPriorityTask, 2) task_manager.add_task(highPriorityTask, 1) task_manager.add_task(reviveKlaatu, 3) task_manager.execute_tasks()

खोज

• [x] मैनुअल

यह एक डिज़ाइन गंध है

टैग

• विश्वसनीयता

निष्कर्ष

सॉफ़्टवेयर घटक बनाएं और वास्तविक और गैर-वास्तविक स्थितियों का अनुकरण करें

रिश्ते

कोड गंध 198 - छिपी हुई धारणाएँ

और जानकारी

अस्वीकरण

कोड गंध मेरी राय है.

एनालिटिकल इंजन को कुछ भी उत्पन्न करने का कोई दावा नहीं है। यह वह सब कुछ कर सकता है जो हम जानते हैं कि इसे निष्पादित करने का आदेश कैसे दिया जाए... लेकिन इसका विज्ञान पर अप्रत्यक्ष और पारस्परिक प्रभाव पड़ने की संभावना है।

एडा लवलेस

सॉफ्टवेयर इंजीनियरिंग महान उद्धरण

कोड गंध 227 - काउबॉय कोडिंग

काउबॉय को हॉलीवुड फिल्मों पर छोड़ दें।

टीएल;डीआर: एक टीम प्रोग्रामर के रूप में कोड लिखें

समस्या

• पठनीयता
• अविश्वसनीय कोड
• लोग प्रबंधन मुद्दे
• तालमेल की कमी

समाधान

1. प्रोफेशनल कोड लिखें.

   
   

2. घोषणात्मक गैर-गूढ़ नामों का प्रयोग करें।

प्रसंग

काउबॉय कोडर्स सर्वोत्तम प्रथाओं का पालन नहीं करते हैं।

वे टीम के सुझावों का पालन नहीं करते.

काउबॉय कोडिंग को आम तौर पर सॉफ़्टवेयर विकास के लिए एक अव्यवसायिक और जोखिम भरा दृष्टिकोण माना जाता है क्योंकि इससे ऐसे कोड बन सकते हैं जिन्हें बनाए रखना कठिन होता है और त्रुटियों की संभावना होती है।

काउबॉय प्रोग्रामर अच्छे लोग हैं; हालाँकि, वे एक समूह में काम नहीं कर सकते ।

नमूना कोड

गलत

 # Very simple example # Compute the sum of two numbers without any structure or best practices. num1 = input("Enter the first number: ") num2 = input("Enter the second number: ") # WARNNING!!!! Don't remove the line below !!!!! # (Unpleasant comment) res = num1 + num2 # (No data type checking or error handling) print("The sum is: " + result) # (No validation or formatting) # (No good names, no functions, no error handling, no testing, # no version control, and no structure.)

सही

 def add_numbers(): try: firstAddend = float(input("Enter the first number: ")) secondAddend = float(input("Enter the second number: ")) total = firstAddend + secondAddend return total except ValueError: print("Invalid input. Please enter valid numbers.") return None def main(): total = add_numbers() if total is not None: print("The sum is: {:.2f}".format(sum)) if __name__ == "__main__": main()

खोज

• [x] मैनुअल

आप इन कोडिंग प्रथाओं को रोकने और टीम निर्माण को लागू करने के लिए पर्यावरण नियम निर्धारित कर सकते हैं।

अपवाद

• बहुत छोटी निजी परियोजनाएँ

टैग

• कथात्मक

निष्कर्ष

सॉफ्टवेयर विकास टीम वर्क है।

रिश्ते

कोड स्मेल 06 - बहुत चतुर प्रोग्रामर

कोड गंध 02 - स्थिरांक और जादुई संख्याएँ

कोड गंध 105 - हास्य विधियाँ

और जानकारी

https://www.linkedin.com/palse/software-development-cowboy-coding-hakan-atbaş/

क्रेडिट

अनस्प्लैश पर टेलर ब्रैंडन द्वारा फोटो

कंप्यूटर से खतरा यह नहीं है कि वे अंततः पुरुषों जितने स्मार्ट हो जाएंगे, बल्कि यह है कि हम इस बीच आधे रास्ते में ही उनसे मिलने के लिए सहमत हो जाएंगे।

बर्नार्ड अविशाई

कोड गंध 228 - प्रति फ़ाइल एकाधिक कक्षाएं

एक से अधिक कक्षाएँ गड़बड़ हैं।

टीएल;डीआर: चिंताओं के पृथक्करण सिद्धांत और फ़ाइल संगठन का पालन करें

समस्या

• कोड संगठन
• युग्मन
• स्वचालित लोडिंग समस्याएँ
• डिबगिंग
• संस्करण नियंत्रण और मर्ज विरोध

समाधान

1. प्रति फ़ाइल एक एकल वर्ग घोषित करें

   
   

2. नाम स्कोपिंग का प्रयोग करें

प्रसंग

उन भाषाओं में जो फ़ाइल सिस्टम का उपयोग करके कक्षाएं घोषित करती हैं, प्रति फ़ाइल एक कक्षा रखना आम तौर पर सर्वोत्तम अभ्यास माना जाता है।

यह दृष्टिकोण कोड संगठन और रखरखाव को बेहतर बनाने में मदद करता है और संभावित मुद्दों को कम करता है।

आप अपनी परियोजना संरचना के भीतर नामस्थानों को अलग-अलग निर्देशिकाओं में व्यवस्थित कर सकते हैं।

इस तरह, आप एक ही फ़ाइल में एकाधिक कक्षाओं की घोषणा के मुद्दों से बचते हुए एक तार्किक और कुशल कोडबेस बनाए रख सकते हैं।

नमूना कोड

गलत

 <? namespace MyNamespace; class Class1 { public function sayHello() { echo "Hello from Class1!\n"; } } class Class2 { public function sayHello() { echo "Hello from Class2!\n"; } }

सही

 <? namespace MyNamespace; class Class1 { public function sayHello() { echo "Hello from Class1!\n"; } }

 <? namespace MyNamespace; class Class2 { public function sayHello() { echo "Hello from Class2!\n"; } }

खोज

• [x] स्वचालित

कई मानक इस नियम को लागू करते हैं

टैग

• युग्मन

निष्कर्ष

अपना कोड व्यवस्थित रखें और ज्ञात मानकों का पालन करें।

रिश्ते

कोड गंध 48 - मानकों के बिना कोड

और जानकारी

क्रेडिट

अनस्प्लैश पर मार्जन ब्लान द्वारा फोटो

आवश्यकताओं या डिज़ाइन के बिना, प्रोग्रामिंग एक खाली टेक्स्ट फ़ाइल में बग जोड़ने की कला है।

लुई श्रीगली

कोड गंध 229 - लालफीताशाही

आपने अपना कोड अत्यधिक जटिल कर दिया है.

टीएल;डीआर: आकस्मिक जटिलता और नौकरशाही से बचें

समस्या

• आकस्मिक जटिलता
• पठनीयता
• विक्षेपण दोष

समाधान

1. MAPPER का उपयोग करके वास्तविक दुनिया की वस्तुओं को जिम्मेदारियाँ सौंपें।

प्रसंग

"लालफीताशाही" कोड की गंध अनावश्यक जटिलता, नौकरशाही, या अत्यधिक कॉन्फ़िगरेशन से संबंधित हो सकती है जो कोडबेस को समझने या बनाए रखने को कठिन बना देती है।

नमूना कोड

गलत

 class VotingSystem: def __init__(self, config): self.config = config def validate_voter(self, voter_id): if self.config['voter_verification_enabled']: # Code to verify the voter's identity goes here def cast_vote(self, voter_id, candidate): if self.config['voting_enabled']: # Code to record the vote goes here def generate_vote_report(self): if self.config['generate_report']: # Code to generate a voting report goes here def audit_voting_system(self): if self.config['audit_enabled']: # Code to perform an audit of the voting system goes here # ... other voting-related methods ... # Usage config = { 'voter_verification_enabled': True, 'voting_enabled': False, 'generate_report': False, 'audit_enabled': True } voting_system = VotingSystem(config) # Voter validation, voting, report generation, # and auditing are handled based on the configuration.

सही

 class VoterVerification: def verify_voter(self, voter_id): # Code to verify the voter's identity goes here class VotingMachine: def cast_vote(self, voter_id, candidate): # Code to record the vote goes here class VoteReporter: def generate_report(self): # Code to generate a voting report goes here class VotingAuditor: def audit_voting_system(self): # Code to perform an audit of the voting system goes here # Usage voter_verification = VoterVerification() voting_machine = VotingMachine() vote_reporter = VoteReporter() voting_auditor = VotingAuditor() # Voter verification, vote casting, report generation, # and auditing are handled separately.

खोज

• [x] अर्ध-स्वचालित

कुछ उपकरण यह अनुमान लगा सकते हैं कि आप अपनी वस्तुओं को अनावश्यक ज़िम्मेदारियों से भर रहे हैं।

टैग

• सूजन

निष्कर्ष

लालफीताशाही कोड की गंध स्पष्ट है क्योंकि डेवलपर्स को यह निर्धारित करने के लिए जटिल कॉन्फ़िगरेशन को नेविगेट करने की आवश्यकता है कि कौन सी सुविधाएं सक्रिय हैं।

इससे न केवल अनावश्यक जटिलता बढ़ती है बल्कि गलत कॉन्फ़िगरेशन की संभावना भी बढ़ जाती है जो आपके सिस्टम की अखंडता को प्रभावित कर सकती है।

रिश्ते

कोड गंध 54 - लंगर नावें

अस्वीकरण

कोड गंध मेरी राय है.

क्रेडिट

अनस्प्लैश पर ब्लोअप द्वारा फोटो

सॉफ़्टवेयर का भ्रम: यदि यह काम करता है, और हम कुछ भी नहीं बदलते हैं, तो यह काम करता रहेगा।

जेसिका केर

कोड गंध 230 - श्रोडिंगर कोड

आपका कोड मृत और जीवित है.

टीएल;डीआर: दौड़ की स्थितियों को ध्यान से देखें

समस्या

• न्यूनतम आश्चर्य उल्लंघन का सिद्धांत
• दौड़ की स्थिति

समाधान

1. दौड़ की स्थिति से बचें

   
   

2. वैश्विक चर से बचें

   
   

3. उचित तुल्यकालन का प्रयोग करें

प्रसंग

श्रोडिंगर कोड वह कोड है जो एक ही समय में दो अलग-अलग राज्यों में हो सकता है, लेकिन कोड की स्थिति तब तक निर्धारित नहीं होती है जब तक कि इसे निष्पादित नहीं किया जाता है।

ऐसा तब हो सकता है जब कोड में रेस की स्थिति होती है, या जब कोड एक वैश्विक चर की स्थिति पर निर्भर करता है जिसे अन्य थ्रेड या प्रक्रियाओं द्वारा बदला जा सकता है।

नमूना कोड

गलत

 import threading cats_alive = 0 def thread_1(): cats_alive += 1 def thread_2(): cats_alive -= 1 if cats_alive > 0: feedThem() # The value of cats_alive is indeterminate, # so the code can be in either of the two states: # # 1. cats_alive > 0 and feedThem() is called. # 2. cats_alive <= 0 and feedThem() is not called.

सही

 import threading lock = threading.Lock() cats_alive = 0 def thread_1(): with lock: cats_alive += 1 def thread_2(): with lock: cats_alive -= 1 if cats_alive > 0: feedThem() # With the lock, the two threads cannot access # the `cats_alive` variable at the same time. # This means that the value of `cats_alive` is always determined, # and the program will not exhibit Schrödinger code behavior.

खोज

• [x] मैनुअल

समवर्ती कोड पर कोड समीक्षा करें

टैग

• संगामिति
• वैश्विक

निष्कर्ष

श्रोडिंगर कोड से बचने के लिए, दौड़ की स्थिति से बचें और वैश्विक चर की स्थिति पर निर्भर होने से बचें जिन्हें अन्य थ्रेड या प्रक्रियाओं द्वारा बदला जा सकता है।

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

रिश्ते

कोड गंध 198 - छिपी हुई धारणाएँ

कोड गंध 32 - सिंगलटन

कोड स्मेल 60 - ग्लोबल क्लासेस

क्रेडिट

अनस्प्लैश पर येर्लिन माटू द्वारा फोटो

आखिरी चीज जो आप चाहते थे कि कोई भी प्रोग्रामर आंतरिक स्थिति में गड़बड़ी करे

एलन के

अगले सप्ताह, 5 और गंधें।