सी ++ स्टाइल कन्वेंशन: कक्षा घोषणा के भीतर पैरामीटर नाम

Question

मैं एक बिल्कुल नया सी ++ प्रोग्रामर हूं और मैं वर्ग घोषणा के भीतर नामकरण पैरामीटर के लिए और इसके खिलाफ तर्क सुनना चाहता हूं।

---

यहाँ एक उदाहरण है:

Student.h

#ifndef STUDENT_H_ 
#define STUDENT_H_ 

#include <string> 

using namespace std; 

class Student 
{ 
    private: 
     string name; 
     unsigned int age; 
     float height, GPA; 

    public: 
     Student(string, unsigned int, float, float); 

     void setAge(unsigned int); 
}; 

#endif /*STUDENT_H_*/ 

बनाम

#ifndef STUDENT_H_ 
#define STUDENT_H_ 

#include <string> 

class Student 
{ 
    private: 
     string name; 
     unsigned int age; 
     float height, GPA; 

    public: 
     Student(string name, unsigned int age, float height, float GPA); 

     void setAge(unsigned int age); 
}; 

#endif /*STUDENT_H_*/ 

Student.cpp

#include "Student.h" 

Student::Student( string name, 
      unsigned int age, 
      float height, 
      float GPA) : 

      name(name), 
      age(age), 
      height(height), 
      GPA(GPA) {} 

void Student::setAge(unsigned int age) { this -> age = age; } 

---

मैं तय नहीं कर सकता। एक ओर, मुझे लगता है कि दोनों घोषणाओं (.h) और परिभाषा (.cpp) में चर का नाम देने के लिए अनावश्यक है। खासकर जब से आप दोनों जगहों पर नाम अपडेट करने की चिंता कर रहे हैं ताकि वे मेल खाते हों। दूसरी ओर, नामों के बिना, यह निर्धारित करने के लिए अक्सर भ्रमित हो सकता है कि पैरामीटर केवल घोषणाओं को देखकर किस चर के अनुरूप हैं।

तो, आपके विचार क्या हैं?

Answer 1

घोषणा में पैरामीटर नामों का उपयोग करना और अच्छे पैरामीटर नामों का उपयोग करना बेहतर है। इस तरह, वे फ़ंक्शन प्रलेखन के रूप में कार्य करते हैं। अन्यथा, आपको अपने शीर्षलेख में अतिरिक्त टिप्पणियां लिखनी होंगी, और टिप्पणियों का उपयोग करने के बजाय अच्छे पैरामीटर/चर नामों का उपयोग करना हमेशा बेहतर होता है।

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

Answer 2

दोनों जगहों पर नाम रखें, स्पष्टता वह इनाम है जो आपको दो स्थानों पर हस्ताक्षर बनाए रखने के कार्य के लिए मिलता है।

Answer 3

भले ही अनावश्यक, मुझे लगता है कि दोनों स्थानों पर पैरामीटर नाम होना बेहतर है। यह आम तौर पर है क्योंकि, पैरामीटर नाम बदलने में अक्सर अर्थपूर्ण परिणाम होते हैं। हेडर में इसे खोने से दस्तावेज़ों को स्क्रू करने में मदद मिलती है (जहां मैं अधिकतर टिप्पणियां यानी एपीआई विनिर्देशों को डालता हूं) और कार्यान्वयन में इसे याद करने में मुझे यह भूलने में मदद मिलती है कि उस विशेष पैरामीटर का इतना अजीब नाम क्यों है।

एकमात्र बार जब मैं एक तृतीय पक्ष लाइब्रेरी कॉलबैक लागू करना चाहता हूं तो मुझे पैरामीटर नाम से गुजरना है और मैं पैरामीटर में से किसी एक का उपयोग नहीं कर रहा हूं। फिर भी मैं करता हूँ चाहते हैं:

my_callback(int idx, Context* /*ctx*/) { ... 

ताकि मैं हस्ताक्षर अच्छी तरह से पता है।

Answer 4

हां, .h फ़ाइल में पैरामीटर का नाम देना आवश्यक नहीं है। एक हेडर फ़ाइल को एक इंटरफेस का प्रतिनिधित्व करना माना जाता है, इसलिए इसे अनियंत्रित विवरण की आवश्यकता नहीं होती है।

HTH

Answer 5

Intellisense/स्वत: पूर्ण/जो कुछ भी समान विकास के वातावरण में है आमतौर पर केवल घोषणा देखता है और केवल स्वत: पूर्ण के रूप में यह दिखा देंगे। इसलिए यदि आप घोषणा में नाम घोषित नहीं करते हैं तो उपयोगकर्ता उन्हें स्वत: पूर्ण रूप से नहीं देख पाएंगे जब तक कि वे स्रोत पर न जाएं और पढ़ सकें।यह शायद सहनशील है, लेकिन बहुत सुविधाजनक नहीं है।

Answer 6

यदि आपने कभी भी अपने कोड को लाइब्रे के रूप में रिलीज़ किया है, तो संबंधित .h फ़ाइल के साथ, आपके उपयोगकर्ता कभी भी परिभाषा को नहीं देख पाएंगे, केवल घोषणा ही करेंगे, अपने आप पर एक्ज़्रा प्रलेखन बोझ जोड़ देंगे।

Answer 7

एक तरफ, मुझे लगता है कि यह अनावश्यक है दोनों घोषणा (ज) और परिभाषा (सीपीपी) में चर नाम है। खासकर के बाद से आपको दोनों स्थानों पर नाम अपडेट करने की चिंता करनी है ताकि वे मैच प्राप्त कर सकें।

आप सचमुच मैच के लिए नामों की जरूरत नहीं है। हेडर फ़ाइल, जो इंटरफ़ेस निर्दिष्ट करती है, एक अपूर्ण अनुबंध की तरह थोड़ा काम करती है (अपूर्ण क्योंकि इसमें पूर्व शर्त और पोस्टकंडिशन नहीं होते हैं, जब तक कि आप उन्हें टिप्पणियों में लिखते नहीं हैं) और "कॉलर की मार्गदर्शिका"। कक्षा के कॉलर जानना चाहते हैं कि 99% मामलों में पैरामीटर क्या हैं। कम से कम इतना है कि वह जानता है कि क्या हो रहा है। इसलिए आपको एक पैरामीटर नाम चुनना होगा जो कॉलर के लिए समझ में आता है। इसे सीपीपी में नाम के समान होने की आवश्यकता नहीं है। हालांकि इससे कोई फर्क नहीं पड़ता, क्योंकि मुझे पहले स्थान पर .h से फ़ंक्शन हस्ताक्षर कॉपी/पेस्ट करने के लिए उपयोग किया जाता है। मेरे लिए, सी ++ में प्रोग्रामिंग इस मैनुअल भाग का तात्पर्य है।

दूसरी ओर, नाम के बिना, यह अक्सर क्या चर मापदंडों अनुरूप सिर्फ घोषणा को देखकर को निर्धारित करने के लिए भ्रामक हो सकते हैं।

यह अच्छा हाथ है।

Answer 8

मुझे लगता है कि यह आपके चर प्रकारों के वर्णनात्मक पर निर्भर करता है। तो नाम शामिल बेमानी है

double calculateTax(int, string); 

प्रकार वर्णनात्मक हैं, तो: अपने विधि हस्ताक्षर कई उद्देश्यों के लिए इस्तेमाल प्रकार होते हैं, तो यह उपयोगी है।

Money calculateTax(Order, State); 

मैं दो फाइलों में नामों को बनाए रखना पसंद नहीं करूंगा।