2010-09-10 6 views
9

मेरे पास SSLXMLRPCServer नाम का एक वर्ग है। क्या यह होना चाहिए या SslXmlRpcServer?यदि मेरे अजगर वर्ग के नाम का संक्षिप्त नाम है, तो क्या मुझे इसे ऊपरी केस, या केवल पहला अक्षर रखना चाहिए?

+0

ठीक है, यह SSLXMLRPCServer होना चाहिए था। :) – gregturn

+0

मुझे दोनों अलग-अलग कारणों से पसंद है।ए) पहला शब्दकोष का "उचित" संस्करण है। बी) दूसरा पढ़ने के लिए आसान है। – gregturn

+0

एक संक्षिप्त नाम संक्षेप है (जिसे बोली जा सकती है), पीईपी 8 संक्षेप में स्पष्ट है: [सभी राजधानियां] (https://www.python.org/dev/peps/pep-0008/#descriptive-naming-styles) CapsWords के बजाय (प्रदान किए गए उदाहरण के रूप में HTTPServerError के साथ) – Anthon

उत्तर

1

मैं आमतौर पर शब्दकोष को अपरकेस करता हूं। मुड़ और कुछ अन्य पुस्तकालय भी ऐसा करते हैं।

9

यह व्यक्तिगत वरीयता का मामला है, लेकिन मुझे दूसरा प्रारूप पढ़ने के लिए बहुत आसान लगता है। तथ्य यह है कि आपके पहले प्रारूप में एक टाइपो है (पीआरसी इसके बजाय या आरपीसी) से पता चलता है कि मैं अकेला नहीं हूं।

+3

.NET के पास एक दिलचस्प लेना है: 2-अक्षर घटक ऊपरी (अधिकांश विशेष रूप से 'IO'; मुझे याद नहीं है वास्तव में 2 अक्षरों में से कोई दूसरा), लेकिन बाकी सब कुछ पास्कल-आधारित है, इसलिए 'एक्सएमएल',' आरपीसी ',' एसएसएल ',' एचटीपी 'इत्यादि अजीब लगता है, लेकिन मैं इसे लिखने वाले लोगों को मूल रूप से' 'आईओ' को देखकर दर्द खड़े हो जाओ। –

2

PEP-8 शब्दकोष के बारे में कुछ भी नहीं बताता है। आप शब्दकोष को उच्चतम रखने के लिए सबसे सुरक्षित होंगे (यह वही है जो मैं सबसे ज्यादा देखता हूं)।

+7

आपका मतलब है, यह इसके अलावा उल्लेख नहीं करता है * नोट: कैपेड में संक्षेप का उपयोग करते समय, संक्षेप के सभी अक्षरों को कैपिटल करें। इस प्रकार HTTPServerError HttpServerError से बेहतर है। * निश्चित रूप से ... :) (यह ध्यान दिया जाना चाहिए कि मैं इस सिफारिश से असहमत हूं।) –

+0

यह टिप्पणी एक उत्तर होना चाहिए था (और फिर इसे उत्तर के रूप में स्वीकार किया जाना चाहिए था; यदि आप ' पाइथन स्वरूपण में क्या करना चाहिए * के बारे में बात कर रहे हैं, पेप -8 वह जगह है जहां यह है)। – machineghost

0

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

+0

यह तब तक सही नहीं लगता जब तक आप इसे शुरू करने का निर्णय नहीं लेते। फिर आप सॉफ़्टवेयर द्वारा वास्तव में परेशान हो जाते हैं जो एक साथ शब्दकोष को जोड़ता है जिससे उन्हें पार्स करना असंभव हो जाता है। –

+0

हमारे मामले में छोड़कर: SSLXMLRPCServer पढ़ने के लिए वास्तव में बहुत मुश्किल है, और इसलिए सही महसूस नहीं हो सकता है (भले ही यह सबसे अच्छा समाधान हो) – mb14

3

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

5

यह SSLXMLRPCServer होना चाहिए, एक नामकरण परंपरा है कि मानक पुस्तकालय में समकक्ष से अलग अपनाने SimpleXMLRPCServer, CGIXMLRPCRequestHandler, आदि

जैसे मानक पुस्तकालय वर्गों मैच के लिए केवल लोगों को भ्रमित करने के लिए जा रहा है।

0

संक्षिप्तता और पठनीयता के लिए कैसे?

मैं अक्सर ऐसा करता हूं जब मैं किसी कारण से ऊंट-मामले से बचना चाहता हूं।

+0

मुझे लगता है कि ऊंट के मामले और सांप के मामले को मिलाकर, आप क्या कर सकते हैं। मेरी राय में, आपको अपवाद के बिना सामान नामकरण का एक तरीका चुनना चाहिए और इसके साथ चिपकना चाहिए। – mb14

+1

@ mb14: "नियमों को तोड़ने के लिए विशेष मामले पर्याप्त नहीं हैं। हालांकि व्यावहारिकता शुद्धता को धड़कता है।" पठनीयता एक व्यावहारिक विशेषता है? –

+1

@ एमबी 14: "एक मूर्खतापूर्ण स्थिरता छोटे दिमाग की होबगोब्लिन है।" – martineau

1

जैसा कि पहले से कहा गया है, पीईपी -8 संक्षेप में ऊपरी मामले का उपयोग करने के लिए कहता है। अब, पायथन जेन भी कहते हैं "पठनीयता गणना" (और मेरे लिए जेन पीईपी :-) पर प्राथमिकता है।

ऐसी अस्पष्ट स्थिति में मेरी राय प्रोग्रामिंग संदर्भ में मानक को ध्यान में रखना है, केवल भाषा ही नहीं। उदाहरण के लिए, कुछ xml-http-query class को सर्वलेट संदर्भ में XMLHttpQuery लिखा जाना चाहिए (w.r.t XMLHttpRequest)।

मुझे आपका संदर्भ पता नहीं है, लेकिन ऐसा लगता है कि XMLRPCServer मौजूद है और आप इसे एसएसएल संलग्न करना चाहते हैं।

SSL_XMLRPCServer

यह है- बदलते -without XMLRPCServer पर बल दिया जाएगा: तो आप की तरह कुछ चुन सकते हैं।
इसके अलावा, आप पेप-8 के लिए और पालन ज़ेन :-)

मेरे 2 सेंट

नोट बने रहने की सुविधा चाहते हैं: यदि XMLRPCServer दृढ़ता से अपने वर्ग से संबंधित नहीं है और वास्तव में डोमेन एक मानक है , तो भ्रमित न होने के लिए आपको एक और नाम चुनना होगा।

संबंधित मुद्दे