नमस्कार ह्रज्जितली!

अब क्यूटी के साथ कई वर्षों के अनुभव वाले कुछ विशेषज्ञ ने सोचा: “यह क्या है? Habr - अचानक चीजों के लिए! ”। लेकिन यहां तक ​​कि कई वर्षों के अनुभव वाले विशेषज्ञों को कभी-कभी सरल चीजों के बारे में ऐसे लेख पढ़ने की आवश्यकता होती है, क्योंकि यह महत्वपूर्ण है। कोड प्रोग्रामिंग के सबसे महत्वपूर्ण घटकों में से एक है। और हमारा काम इसे साफ रखना है। यह लेख सभी क्यूटी प्रोग्रामर के लिए समर्पित है जो आदर्श के लिए प्रयास करते हैं।

बेशक क्यूटी प्रोजेक्ट पर एक लेख है - क्यूटी कोडिंग स्टाइल । केवल यहाँ कम मूल्यवान सामग्री है ...

नंबर 1 पर पोस्ट करें। संरेखण

Qt में यह 4 स्थानों के इंडेंटेशन का उपयोग करने के लिए प्रथागत है। लेकिन ठीक 4, और ठीक एक अंतराल। रिक्त स्थान के लिए \ t या किसी अन्य स्थान का उपयोग करना बहुत बुरा माना जाता है और गंभीर रूप से दंडित किया जाता है ।

संख्या 2 को अंकित करें। परिवर्तनीय घोषणा

सबसे महत्वपूर्ण पदों में से एक, क्योंकि यह कोड की पठनीयता और सामान्य शैली को निर्धारित करता है। चर घोषित करने के नियम निम्नलिखित सूची में एकत्र किए गए हैं:

• प्रत्येक चर को एक अलग रेखा पर घोषित करें
• छोटे या लेकोनिक नामों से बचें (उदा। "A", "rbarr", "nughdeget")
• तब तक प्रतीक्षा करें जब तक कि चर की जरूरत न हो, और उसके बाद ही घोषित करें
• फ़ंक्शंस और वेरिएबल्स कैमलकेस में होने चाहिए
• संक्षिप्त और संक्षिप्त से बचें
• कक्षाओं को हमेशा एक बड़े अक्षर से शुरू करना चाहिए
• सार्वजनिक वर्गों को 'क्यू' (क्यूआरजीबी) अक्षर से शुरू करना चाहिए, फिर कैपिटल लेटर
• सार्वजनिक कार्यों को 'q' अक्षर से शुरू करना चाहिए (qRgb)
• संकेतन PascalCase (जैसे QXMLStreamReader के बजाय QXmlStreamReader) में होना चाहिए

//  int a, b; char *c, *d; //  int height; int width; char *nameOfThis; char *nameOfThat; 

 //  short Cntr; char ITEM_DELIM = '\t'; //  short counter; char itemDelimiter = '\t'; 

3 नंबर पर पोस्ट करें। अंतराल

सोर्स कोड को फॉर्मेट करने में स्पेस बहुत महत्वपूर्ण तत्व हैं। यह कोड पठनीयता में बहुत बड़ी भूमिका निभाता है।

• अलग-अलग कोड सेगमेंट को समूह में उपयोग करें
• अलगाव के लिए केवल एक खाली रेखा का उपयोग किया जा सकता है।
• हमेशा कीवर्ड और घुंघराले ब्रेस के बाद केवल एक और केवल एक ही स्थान का उपयोग करें
• पॉइंटर्स और रेफरेंस के लिए, हमेशा एक प्रकार के और '*' या 'और' के बीच का उपयोग करें, लेकिन '*' या 'और' और चर के नाम के बीच कभी भी स्पेस न रखें
• रिक्त स्थान के साथ बाइनरी ऑपरेटरों को घेरें
• कास्टिंग के बाद कोई स्थान नहीं
• सी-जैसे भूत से बचने की कोशिश करें।

 //  if (foo){ } //  if (foo) { } 

 char *x; const QString &myString; const char * const y = "hello"; MyClass *obj = new MyClass(this); bool ok; obj.report(1, &ok); 

 //  char* blockOfMemory = (char* ) malloc(data.size()); QTextStrem newOne(..); newOne<<"Hello"<<","<<" "<<"world"; //  char *blockOfMemory = reinterpret_cast<char *>(malloc(data.size())); QTextStrem newOne(..); newOne<< "Hello" << "," << " " << "world"; 

4 नंबर पर पोस्ट करें। कोष्ठक

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

• एक मूल नियम के रूप में, बाईं घुंघराले ब्रैकेट ऑपरेटर के समान रेखा पर है:
• अपवाद : कार्यों और वर्ग की घोषणाओं का कार्यान्वयन, हमेशा हमेशा एक नई पंक्ति पर बाएं कोष्ठक को रखें:
• जब कर्ल बॉडी में एक से अधिक लाइन होते हैं, और यदि एक-लाइन ऑपरेटर कुछ जटिल होता है, तो कर्ली ब्रेसिज़ का उपयोग करें
• अपवाद 1 : यदि पैरेंट स्टेटमेंट कई लाइनों या आवरणों को फैलाता है, तो कोष्ठक का भी उपयोग करें
• अपवाद 2 : यदि-कोड या अन्य-कोड कई पंक्तियों में स्थित है, तो इफ-ब्लॉक में कोष्ठक का भी उपयोग करें
• ऑपरेटर बॉडी खाली होने पर कर्ली ब्रेसेस का उपयोग करें

 static void foo(int g) { qDebug("foo: %i", g); } class Moo { public: Moo(); Moo(int a, int b); public slots: int getResult(); protected slots: void processNumbers(); private: int mineA; int mineB; int mineResult; }; 

 //  if (address.isEmpty()) { return false; } for (int i = 0; i < 10; ++i) { qDebug("%i", i); } //  if (address.isEmpty()) return false; for (int i = 0; i < 10; ++i) qDebug("%i", i); 

 //  while (a); if (expression) else // do something //  while (a) {} if (expression) { } else { // do something } 

 //  if (codec) { // do something } //  if (codec) { // do something } 

 //  if (address.isEmpty()) return false; else { qDebug("%s", qPrintable(address)); ++it; } //  if (address.isEmpty()) { return false; } else { qDebug("%s", qPrintable(address)); ++it; } //  if (a) if (b) ... else ... //  if (a) { if (b) ... else ... } 

 //  if (address.isEmpty() || !isValid() || !codec) return false; //  if (address.isEmpty() || !isValid() || !codec) { return false; } 

5 नंबर पर पोस्ट करें। कोष्टक

समूह अभिव्यक्तियों के लिए कोष्ठकों का उपयोग करें:

 //  if (a && b || c) if (a + b & c) //  if ((a && b) || c) if ((a + b) & c) 

6 नंबर पर पोस्ट करें। एकाधिक चयन शर्तें स्विच

बेशक, ये स्थितियां कोडिंग दिशानिर्देशों के डेवलपर्स और रचनाकारों की ओर से कई चर्चाओं का कारण हैं - बहुत सारे अलग-अलग विकल्प हो सकते हैं। हालाँकि, Qt केवल यह विकल्प प्रदान करता है:

• केस स्टेटमेंट स्विच स्टेटमेंट के समान कॉलम में होना चाहिए
• प्रत्येक मामले को एक विराम (या वापसी) बयान या टिप्पणी के साथ समाप्त होना चाहिए ताकि यह दिखाया जा सके कि एक और मामला इस प्रकार है।

 switch (myEnum) { case Value1: doSomething(); break; case Value2: case Value3: doSomethingElse(); // fall through default: defaultHandling(); break; } 

7 नंबर पर पोस्ट करें। लाइन ब्रेक

अक्सर निम्नलिखित होता है: एक बड़े मॉनिटर के साथ एक डेवलपर वासा होता है। वह खुद को शांति से कोड लिखता है। फिर यह कोड डेवलपर पेट्या द्वारा एक लैपटॉप के साथ खोला जाता है, और स्पष्ट रूप से देखता है - पूरे कोड को पढ़ने के लिए उसे बहुत स्क्रॉल करना पड़ता है। यह पठनीयता दोषों में से एक है। मुक्ति के लिए Qt क्या प्रदान करता है?

• 100 वर्णों से अधिक लंबी लाइनों को रखने का प्रयास करें; यदि आवश्यक हो तो उन्हें काट दें
• कॉम्म्स एक झूलने वाली रेखा के अंत में स्थित हैं; ऑपरेटरों को एक नई लाइन की शुरुआत में लपेटा जाना चाहिए। लाइन के अंत में ऑपरेटर यह देखना बहुत आसान है कि आपका संपादक बहुत संकीर्ण है या नहीं

 //  if (longExpression + otherLongExpression + otherOtherLongExpression) { } QMessageBox::information(d->someObjectWithLongName, tr("A long title for mesage"), tr("A very very very very very very long body", QMessageBox::Ok, QMessageBox::Cancel); //  if (longExpression + otherLongExpression + otherOtherLongExpression) { } QMessageBox::information(d->someObjectWithLongName, tr("A long title for mesage"), tr("A very very very very very very long body", QMessageBox::Ok, QMessageBox::Cancel); 

UPD: कोड का अंतिम भाग गलत तरीके से प्रदर्शित किया गया है - सभी लाइनें समान स्तर पर होनी चाहिए

8 नंबर पर पोस्ट करें। वंशानुक्रम और `आभासी` कीवर्ड

इस आसन में, सब कुछ बेहद सरल है - मुख्य बात यह है कि .h फ़ाइल में रिडिफाइन विधि के नाम से पहले `वर्चुअल` लिखना नहीं है।

 //  class MyWidget : public QWidget { ... protected: virtual void keyPressEvent(QKeyEvent *); //  class MyWidget : public QWidget { ... protected: void keyPressEvent(QKeyEvent *); 

9 नंबर पर पोस्ट करें। सामान्य अपवाद

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

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

समापन

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

मेरे लिए, क्यूटी कोडिंग स्टाइल कोड लिखने के लिए एकदम सही शैली है। मुझे यह साफ, आरामदायक, सुखद लगता है। इसके उपयोग के सभी समय के लिए, मुझे कोड की पठनीयता से कोई समस्या नहीं थी। क्या मैं इसकी सिफारिश करूंगा? बेशक, हाँ! इसके अलावा, मेरा मानना ​​है कि यह ठीक वही है जिसे Qt प्लेटफॉर्म पर सभी नए लोगों को पदोन्नत किया जाना चाहिए।

आपका ध्यान देने के लिए धन्यवाद।