documentation पर टैग किए गए जवाब

बहुत सारे लोग दावा करते हैं कि "टिप्पणियों में 'क्यों' की व्याख्या होनी चाहिए, लेकिन 'कैसे' नहीं।" दूसरों का कहना है कि "कोड को स्व-दस्तावेजीकरण होना चाहिए" और टिप्पणियों को दुर्लभ होना चाहिए। रॉबर्ट सी। मार्टिन का दावा है कि (मेरे अपने शब्दों में कहा गया है) अक्सर "टिप्पणियां बुरी …

236 programming-practices  documentation  comments 

मुझे विशेष रूप से लाइन द्वारा लाइन देने के लिए कहा गया है (या उपयुक्त के रूप में - उदाहरण के लिए, छवि द्वारा छवि, आदि) स्पष्टीकरण या टिप्पणी जो मेरे मालिक को पढ़ने और पालन करने में सक्षम होना चाहते हैं। चूंकि वह एक प्रोग्रामर नहीं है, इसलिए वह …

155 documentation 

RFC 2606 मानक प्रलेखन में उदाहरण के रूप में इस्तेमाल किए जाने के उद्देश्य के लिए डोमेन नाम example.org , example.net और example.com को सुरक्षित रखता है । फ़ोन नंबर (देश कोड सहित) के लिए एक समतुल्य क्या है, जिसका उपयोग एक उदाहरण के रूप में किया जा सकता है, …

112 documentation  standards  help-documentation 

मान लीजिए कि मैं एक अपेक्षाकृत बड़ी परियोजना विकसित कर रहा हूं। मैंने पहले से ही अपने सभी वर्गों और कार्यों को डॉक्सीजेन के साथ दस्तावेजित किया है, हालांकि, मुझे प्रत्येक स्रोत कोड फ़ाइल पर "प्रोग्रामर के नोट्स" डालने का विचार था। इसके पीछे विचार यह है कि आम आदमी …

104 documentation  large-scale-project 

नवीनतम संस्करण से तीसरे पक्ष के एसडीके के रोलबैक के बारे में एक बैठक के दौरान यह ध्यान दिया गया था कि हमारे डेवलपर्स ने पहले ही प्रतिबद्ध किया था कि नवीनतम संस्करण का उपयोग नहीं किया जाना चाहिए। कुछ डेवलपर्स ने तर्क दिया कि यह एक बुरा अभ्यास था …

94 version-control  documentation 

मैं काफी बड़े प्रोजेक्ट पर काम कर रहा हूं और मुझे इसके लिए कुछ अनुवाद करने का काम मिला है। कई टन लेबल थे जिनका अनुवाद नहीं किया गया था और जब मैं कोड के माध्यम से खुदाई कर रहा था तो मुझे कोड का यह छोटा सा टुकड़ा मिला …

86 documentation  comments 

मैंने निम्नलिखित कोड लिखा है: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.persist(boutique); } else { boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); //boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.merge(boutique); } यहाँ एक टिप्पणी-बाहर लाइन है। लेकिन मैं इसे कोड साफ बनाता है, स्पष्ट कर …

83 documentation  comments 

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

78 documentation  comments 

मैं तीन महीने पहले एक परियोजना पर काम कर रहा था, और फिर अचानक एक और जरूरी परियोजना दिखाई दी और मुझे अपना ध्यान स्थानांतरित करने के लिए कहा गया। कल से, मैं पुराने प्रोजेक्ट पर वापस जा रहा हूँ। मुझे एहसास है कि मुझे याद नहीं है कि मैं …

72 project-management  documentation 

मैं अपनी वर्तमान नौकरी छोड़ने की योजना बना रहा हूं क्योंकि हम एक ब्लूब का उपयोग करने में बंद हैं , एक एंटरप्राइज़ ब्लब फ्रेमवर्क और एक ब्लब-स्तरीय वेब सर्वर के साथ, औसत दर्जे की साझा होस्टिंग पर। मेरे सहकर्मी मित्र हैं और मेरे बॉस एक औसत छोटे व्यवसाय के …

66 career-development  documentation 

मैं अच्छी तरह से प्रलेखित कोड के महत्व को समझता हूं। लेकिन मैं स्व-दस्तावेज कोड के महत्व को भी समझता हूं । किसी विशेष फ़ंक्शन को नेत्रहीन पढ़ना आसान है, हम सॉफ़्टवेयर रखरखाव के दौरान तेजी से आगे बढ़ सकते हैं। इसके साथ ही कहा, मुझे बड़े कार्यों को अन्य …

63 programming-practices  code-quality  documentation 

ऑटोमैटिक डॉक्यूमेंटेशन जेनरेशन कई तरह के टूल्स के साथ किया जा सकता है, घोस्टडॉक सबसे प्रमुख में से एक है। हालांकि, परिभाषा के अनुसार, यह सब कुछ उत्पन्न करता है बेमानी है। यह तरीकों, वर्गों, आदि के नामों पर एक नज़र रखता है और अंग्रेजी को आउटपुट करता है जो …

60 documentation  automation  automatic-programming 

मैं उपयोगकर्ता प्रलेखन (एक एसओपी) लिख रहा हूं जिसमें तीसरे पक्ष के कार्यक्रम शामिल हैं जिन्हें मैं अच्छी तरह से वर्णन करने की कोशिश कर रहा हूं। ऐसा ही एक कार्यक्रम एक सर्वर है जो स्टार्टअप के अलावा इसके प्रारंभ / स्टार्टअप दिनचर्या के दौरान दिखाए जाने वाले ग्राफिक के …

59 documentation  component  jargon 

कभी-कभी मैं खुद को ऐसी स्थितियों में पाता हूं जब मैं जो कोड लिख रहा हूं (या लगता है ) इतना आत्म-स्पष्ट है कि इसका नाम मूल रूप से एक टिप्पणी के रूप में दोहराया जाएगा: class Example { /// <summary> /// The location of the update. /// </summary> public …

54 programming-practices  documentation  language-agnostic 

जब आप jsdocs जैसे टूल का उपयोग करते हैं , तो यह आपके कोड में टिप्पणियों के आधार पर आपके HTML कोड में स्थिर HTML फ़ाइलों और इसकी शैलियों को उत्पन्न करता है। क्या इन फाइलों को गिट रिपॉजिटरी में चेक किया जाना चाहिए या उन्हें .ignignore के साथ अनदेखा …

49 git  documentation