Jforex - api - प्रलेखन उपकरण

JForex API JForex API जावा प्रोग्रामिंग भाषा का उपयोग कर कस्टम सॉफ्टवेयर अनुप्रयोगों को विकसित करने की संभावना प्रदान करता है। एपीआई क्लाइंट लाइब्रेरी ग्राहक प्रणालियों से जुड़ी हो सकती है। यह सीधे और प्रमाणित इंटरनेट सत्रों पर Dukascopy बैंक व्यापार सर्वर के साथ सीधे संपर्क करता है। यह एक ही समय में जूटफोर्म मंच को चलाने के लिए आवश्यक नहीं है, लेकिन एक ग्राहक प्रणाली द्वारा किसी भी कार्यवाही के वास्तविक समय में निगरानी के लिए मंच का उपयोग किया जा सकता है। JForex Software Development Kit (JForex SDK) के साथ काम करना शुरू करने के लिए, इसे अपनी पसंद के जावा इंटीग्रेटेड डेवलपमेंट एन्वायरमेंट (आईडीई) में डाउनलोड और आयात करें: जॉरोबॉक्स एसडीके में निम्न के लिए उदाहरण हैं: रणनीति लाइव डेटा रणनीति के साथ चल रही है, विज़ुअल मोड में परीक्षण जोरोबॉक्स एसडीके ओवरव्यू बताता है कि उन उपयोग के मामलों को कैसे संशोधित और बढ़ाया जाए। रणनीति विकास के लिए, रणनीति एपीआई अवलोकन के साथ शुरू करें नवीनतम जॉरोक्स एसडीके निर्भरताएं हमेशा सार्वजनिक डुकास्कापी मेवन रिपॉजिटरी में पाई जा सकती हैं। जिसका अर्थ है कि कोई भी अपना नवीनतम प्रोजेक्ट कॉन्फ़िगर कर सकता है ताकि नवीनतम जर्बेटी एपीआई संस्करण का उपयोग किया जा सके। हमारे नवीनतम ज़ोर्क्स एपीआई विकास के साथ अद्यतित रहें और स्वत: जेरोक्स एपीआई रिलीज नोट ई-मेल की सदस्यता लें। साथ ही, हमारे एपीआई समर्थन फोरम की जांच करना मत भूलना जहां सभी जेफोन्क्स एपीआई रिलीज़ प्रकाशित और चर्चा की जा रही हैं। आईएम को एक वेब सेवा बनाने में कामयाब रहा है जिसका उपयोग विभिन्न प्लेटफार्मों का उपयोग करके कई अलग-अलग डेवलपर्स द्वारा किया जाएगा, विभिन्न कंपनियों के लिए काम करना, और बहुत अलग कौशल स्तरों। जैसे, मैं इस वेब सेवा एपीआई के लिए दस्तावेज बनाना चाहूंगा जो कि संपूर्ण और समझने में बहुत आसान है। यद्यपि मुझे यकीन है कि यह एक महान लक्ष्य है कि सभी प्रलेखन परियोजनाओं को प्राप्त करने का प्रयास है, मुझे अपने प्रोजेक्ट को प्राप्त करने में मदद करने के लिए उपकरण और वर्कफ़्लो का सर्वश्रेष्ठ सेट नहीं मिला है। महान एपीआई दस्तावेज बनाने में आपको कौन से उपकरण और तकनीक सबसे अधिक उपयोगी पाते हैं क्या आप अपने उपयोगकर्ताओं को अपनी सेवाओं का उपयोग करने के लिए आवश्यक सभी जानकारी के साथ अंतिम उपयोगकर्ताओं को उपलब्ध कराने के लिए पर्याप्त ऑटो-प्रजनन प्रलेखन उपकरण पाते हैं क्या आपको विकी आधारित औज़ारों को आसानी से और तेजी से बनाए रखने में आसानी होती है। अपने एपीआई के अप-टू-डेट दस्तावेज क्या आपको कोई भी टूल्स या तकनीक मिल गई है जो दोनों ही दुनिया का सर्वोत्तम प्रदान करती है - स्वचालन और लचीलेपन कोई भी उपकरण मौजूद है जो किसी एपीआई के दस्तावेजों के कई संस्करणों की प्रक्रिया को आसान बनाते हैं, 4 जनवरी से 10 : 11 लासेस वी। कार्लसन द्वारा रचनात्मक नहीं के रूप में बंद 11 अक्टूबर 9: 9:02 के रूप में यह वर्तमान में खड़ा है, यह प्रश्न हमारे कम्पा प्रारूप के लिए उपयुक्त नहीं है। हमें उम्मीद है कि तथ्यों को तथ्यों, संदर्भों या विशेषज्ञता द्वारा समर्थित किया जाए, लेकिन यह प्रश्न बहस, तर्क, मतदान या विस्तारित चर्चा की मांग करेगा। अगर आपको लगता है कि यह प्रश्न सुधार और संभवतः पुनः खोला जा सकता है, तो मार्गदर्शन के लिए सहायता केंद्र पर जाएं। यदि इस प्रश्न को सहायता केंद्र में नियमों में फिट करने के लिए फिर से बदला जा सकता है कृपया प्रश्न संपादित करें 1 महान सवाल ndash Eran Medan 13 जनवरी 10 पर 8:24 15 उत्तर Ive किया मेरे पीएच. डी. जावा में एपीआई दस्तावेज़ीकरण पर वेब सेवाएं स्पष्ट रूप से अलग हैं, लेकिन मुझे विश्वास है कि कुछ शोध वैश्विक हैं सबसे पहले, आपको इस तथ्य को स्वीकार करना होगा कि आपके पास दो कक्षा पाठकों होंगे। एक छोटे से वर्ग ऐसे लोग होंगे जो प्रत्येक फ़ंक्शन के लिए पूरी तरह से पढ़ते हैं। जावा के साथ, आप चाहते हैं कि आपका एपीआई डीसी प्रत्येक फ़ंक्शन को पूरी तरह निर्दिष्ट हो। आप अपने उपयोगकर्ताओं (या इंटरनेट फ़ोरम) को अनुमान नहीं लगाते हैं दुर्भाग्य से, यह वर्ग काफी छोटा है, और अक्सर मिशन महत्वपूर्ण ग्राहकों के साथ या संगठित कोड समीक्षाओं के साथ होता है। एपीआई प्रलेखन उपयोगकर्ता का और अधिक सामान्य रूप है, मैं सिर्फ चीजों को व्यक्ति के प्रकार के रूप में प्राप्त करना चाहता हूं। वह (या उसके) का एक विचार है कि वे क्या हासिल करना चाहते हैं। उन्हें यह पता चलना भी है कि यह कहां से है, तो कह सकते हैं कि वे आपके फ़ंक्शन को ढूंढ चुके हैं। यहां वह समस्या है जहां समस्या शुरू होती है - वे दस्तावेज़ों को वास्तव में पढ़ना नहीं चाहते हैं। अब मान लीजिए कि आपके कॉल में पांच मापदंड हैं, चार स्पष्ट हैं लेकिन एक को एक चेतावनी है (उदाहरण के लिए केवल एक खुला सत्र भेजें)। यदि आप मापदंडों की सूची के माध्यम से जाते हैं और प्रत्येक को पूरी तरह से निर्दिष्ट करते हैं, तो वे थका हुआ हो जाएंगे और स्किम करेंगे और महत्वपूर्ण बात नहीं देखेंगे। मैं इस पर्याप्त तनाव नहीं कर सकता हूं - लोग पूरी तरह से कुछ ऐसा ध्यान नहीं देंगे जो उन्हें चेहरे पर झुकाता है यह भी मुश्किल हो जाता है - अगर वे मानते हैं कि वे पूरी तरह से समारोह को समझते हैं, भले ही वे दस्तावेज़ीकरण को पढ़ने की परेशानी न करें, तो वे सबसे अधिक संभावना-इसे छोड़ देंगे मैंने लोगों को दो-वाक्य दस्तावेजीकरण के तरीकों पर स्पष्ट चेतावनियों को याद किया है। तो यह है कि आप क्या कर सकते हैं: मान लें कि अधिकांश उपयोगकर्ता वास्तव में उन कार्यों के दस्तावेज नहीं पढ़ेंगे जो वे कहते हैं। वास्तव में, आपकी एपीआई अधिक सहज है, कम संभावना है कि कोई दस्तावेज पढ़ सकता है। हर कोई एक अजीब नाम के साथ एक समारोह और 20 पैरामीटर पढ़ा होगा। लेकिन यदि आप एक गंदा चेतावनी के साथ एक सच्चे सीधी एपीआई लिखते हैं, तो आप इसे कभी भी पढ़ा नहीं जा सकता है। केवल एकमात्र समाधान (मैं जावा के लिए कुछ है, लेकिन वेब के लिए नहीं) आश्चर्य से बचने के लिए है जब आप अपना पूर्ण और पूर्ण एपीआई लिखते हैं, तो स्पष्ट रूप से नॉर्टिविअल बिट्स को उजागर करते हैं (मैं आपको जावा में बहुत आश्चर्यचकित कर रहा है, इस बारे में एक संपूर्ण वर्गीकरण दिखा सकता है, बहुत अनुवाद) बेहतर अभी तक, तीन लोगों के दस्तावेज को देखो और उन चीजों को उठाओ जो सहज नहीं हैं यदि आप उन्हें एपीआई से बाहर का सामना नहीं कर सकते हैं, तो उनको हाइलाइट करें। अंत में (और यहां क्रेडिट जेफ स्टाइलोस के लिए है, जिन्होंने एपीआई पर पीएचडी भी किया है): कुछ आपरेशनों (यहां तक ​​कि एक अलग वेब पेज के रूप में) के लिए व्यंजनों को प्रदान करें, और उन तरीकों के लिए दस्तावेज़ पाठ में प्लेसहोल्डर बनाने पर विचार करें जो कि भाग नहीं हैं एपीआई की लेकिन उपयोगकर्ताओं conciveably चाहते हैं उदाहरण के लिए, यदि बहुत से उपयोगकर्ता Z करना चाहते हैं, लेकिन इसे आपके एपीआई में करने का तरीका एक्स और फिर वाई करना है, डू जेड प्लेसहोल्डर के दस्तावेज में जोड़ें, और एक्स और वाई। सेठ को कॉल करने के लिए विशेष रूप से बताएं, समस्या यह है कि आपको हमेशा एक अपवाद नहीं मिलता है। उदाहरण के लिए, मान लीजिए कि आप जेएमएस में संदेश भेजने के लिए कोड देखते हैं। यह पूरी तरह से अच्छी तरह से काम करता है यदि आप अब उस कोड को कॉपी करते हैं और संदेश प्राप्त करने का प्रयास करते हैं, तो यह सिर्फ प्रोग्राम को लटकाएगा। इसका कारण यह है कि आप कतार शुरू करना चाहते हैं, लेकिन इसका एकमात्र संकेत फैक्ट्री मेथड क्यूएक्शन कनेक्शन के javadocs में है। जब मैंने इसे एक प्रयोगशाला अध्ययन में किया, तो ज्यादातर लोगों ने उस समारोह में कभी नहीं देखा। फिर भी यह एक सही व्यवहार है - जब तक आप स्पष्ट रूप से शुरू नहीं करते हैं तब तक संदेशों को वितरित नहीं किया जाना चाहिए। ndash Uri Jan 13 10 at 16:25 कुछ दोगुना तकनीकों मैं कठोर तरीके से सीखा है: सिंटैक्स आरेख (विशेष रूप से रेल आरेख) आदेशों और विकल्पों के सिंटैक्स का वर्णन करने के लिए एक बहुत ही स्पष्ट, पठनीय तरीके प्रदान करते हैं। हमेशा उपयोग किए जाने वाले प्रत्येक फ़ंक्शन कॉन्सेप्ट के लिए हमेशा कम से कम एक उदाहरण प्रदान करें अधिमानतः, एक सरल उपयोग और एक जटिल एक शामिल करें उल्टे पिरामिड लेखन शैली का उपयोग करें - पहले सबसे महत्वपूर्ण जानकारी प्रदान करें, फिर क्रमशः कम महत्वपूर्ण है यह आपके उपयोगकर्ता को यह चुनने की सुविधा देता है कि उनकी ज़रूरत के विस्तार के आधार पर कितना पढ़ा जाए। संपूर्ण दस्तावेज पर भी लागू होता है - पहले खंड में अवधारणाएं दें, और अंत तक सटीक विवरण सहेजें। ट्यूटोरियल या नमूनें जरूरी हैं, और न ही तुच्छ और न ही जटिल रूप से जटिल होना चाहिए अपने दूतों को पढ़ने के लिए अपने उपयोगकर्ताओं को अपनी अपनी ब्रैकेट, ब्रेसिज़, कोण ब्रैकेट, और बोल्डटाइल कंसट्रैनिलिंग्स को जानने के लिए बाध्य न करें। हां, आपके पास एक सुसंगत प्रणाली होनी चाहिए, लेकिन इसे आम सम्मेलनों में से एक का पालन करना चाहिए, या जहां संभव हो वहां सिंटैक्स आरेखों का उपयोग करना चाहिए। उत्तर दिया 12 जनवरी 10:31 पर 1:31 कुछ हफ्ते पहले मैंने ओपन सोर्स कोड प्रलेखन के लिए एक मानक प्रस्तावित किया जो ओपन सोर्स कोड के दस्तावेज के लिए कुछ ढीले दिशानिर्देश देता है। याकूब कपलान-मोस ने इस विषय पर लेखों की एक श्रृंखला भी लिखी है। संक्षेप में, मेरा मानना ​​है कि अधिकांश एपीआई निम्न अनुभागों के साथ अच्छी तरह से प्रलेखित हो सकते हैं: यह क्या है और आप इसका उपयोग क्यों करना चाहते हैं। इसे डाउनलोड करने, इंस्टॉल करने, और कॉन्फ़िगर करने के तरीके कैसे करें (एक ट्यूटोरियल) कैसे करें इसके साथ अधिक उन्नत चीजें (सामयिक मार्गदर्शिकाएँ) एपीआई दस्तावेज़ीकरण (ऑटो-जनरेटेड) ये खंड उसी स्थान पर प्रकाशित नहीं हो सकते हैं (वे अलग-अलग वेब साइट पर हो सकते हैं), या उसी उपकरण (विकी, ऑटो-डॉक जनरेटर, आदि), लेकिन प्रत्येक अनुभाग को प्रत्येक दूसरे अनुभाग (प्रत्येक स्रोत के शीर्ष पर सामग्री की तालिका होना चाहिए) से लिंक के माध्यम से सीधे पहुंचा जा सकता है। यह आपको दस्तावेज़ के प्रत्येक अनुभाग के लिए सबसे उपयुक्त उपकरण का उपयोग करने की अनुमति देता है और अभी भी सभी प्रासंगिक क्षेत्रों को संबोधित करता है। मुझे लगता है कि इस तरह एक बहु-उपकरण दृष्टिकोण आवश्यक है क्योंकि: ऑटो-जनरेट किए गए दस्तावेज़ नवीनतम एपीआई के साथ रहते हैं लेकिन शुरुआती विकी के लिए बेकार शामिल हैं, लेकिन इसमें शामिल समुदाय को शामिल नहीं किया जा सकता, लेकिन लगातार एपीआई परिवर्तनों के साथ कठबोली रहना README फ़ाइलें बहुत स्थिर हैं, फिर भी, लंबे समय तक जैसा कि प्रत्येक अनुभाग प्रत्येक अनुभाग से सुलभ होता है, मुझे लगता है कि बहुविध उपकरण का उपयोग करना सबसे अधिक समय दस्तावेज़ करने का सबसे अच्छा तरीका है। उत्तर में 4 जनवरी 20-30 पर अच्छा प्रस्ताव दिया गया। मैं दस्तावेज़ीकरण के घटकों के ऐसे सहायक दस्तावेजों को ढूँढ़ने की कोशिश कर रहा हूं जो मुझे आपकी रूपरेखा का पालन करने के लिए उपयोगी होगा। धन्यवाद। ndash David LeBauer 4 दिसंबर 10 10:17 पर 5:17 कई पिछले पोस्टर की भावनाओं के साथ सहमत हुए, कई उपयोगकर्ता दस्तावेज नहीं पढ़ा जाएगा। मेरे अनुभवों में, दस्तावेज़ीकरण के तीन तरीके होते हैं, जब एक साथ उपयोग किया जाता है, एक बहुत ही शक्तिशाली और उपयोगी उपकरण बनाते हैं। स्तर 1: स्व-दस्तावेजीकरण कोड जितना संभव हो उतना संभव है, आपके एपीआई को यथासंभव छोटे दस्तावेज की आवश्यकता हो। अपने फ़ंक्शंस, पैरामीटर और डेटा प्रकारों के लिए सम्मेलनों का नामकरण (और प्रकाशित करें) का पालन करें जो उनके उद्देश्य को स्पष्ट करते हैं सबसे अच्छा प्रलेखन वह दस्तावेज है जो आवश्यक नहीं है। लेयर 2: वायंड्रूस नमूना कोड जबकि कई लोग एपीआई दस्तावेज़ीकरण के माध्यम से पढ़े नहीं गए, नमूना कोड के माध्यम से पढ़ना आम तौर पर कम दर्दनाक (और कुछ और अधिक उपयोगी) माना जाता है। कुछ सरल, सरल उदाहरण बनाएं जो आपके एपीआई का उपयोग करते हैं और उन्हें अपने एपीआई डॉक्स से अलग से प्रकाशित करते हैं। संभव के रूप में कई आम उपयोग परिदृश्यों को कवर करें हालांकि यह अभ्यस्त उपयोगकर्ताओं को एपीआई सीखने के समान ही ज्ञान प्रदान करता है, यह कम से कम कई उपयोगकर्ताओं को एक प्रारंभिक बिंदु देगा। यहां तक ​​कि अगर वे केवल नमूना कोड काट और पेस्ट करते हैं और अपने लिए एक कंकाल के रूप में उपयोग करते हैं, तो वे ज्ञात कामकाजी कोड के साथ शुरू हो जाएंगे और आप शुरुआती प्रश्नों और समर्थन अनुरोधों की संख्या को कम कर देंगे। स्तर 3: विस्तारित, हमेशा-अपडेट किए गए दस्तावेज़ चाहे बहुत सारे लोग इसे पढ़ते हैं या नहीं, हमेशा उपलब्ध विस्तृत दस्तावेज उपलब्ध कराने के लिए हमेशा महत्वपूर्ण होता है। ऐसा करने के लिए, मैं दस्तावेज़ जनरेटर जैसे डोक्सीजन का उपयोग करना पसंद करता हूं। यह विशेष रूप से सबसे अच्छा काम करता है अगर आपके पास कुछ प्रकार की स्वचालित बिल्ड प्रक्रिया है हमारी परियोजना के लिए, हमारे पास एक ऐसा सर्वर है जो रात्रि बनाता है और प्रोजेक्ट प्रलेखन रात भर पुन: उत्पन्न करता है इस तरह, जब भी वे वेब पर उन्हें देखते हैं, तब तक सभी सबसे अद्यतित दस्तावेज़ देख सकते हैं दस्तावेज़ जनरेटर कई फायदे देते हैं। सबसे पहले, अपने दस्तावेज़ को हर समय अद्यतित रखना आसान है। चूंकि जनरेटर अपने उत्पादन को बनाने के लिए स्रोत कोड के अंदर टिप्पणियाँ और नोटेशन का उपयोग करते हैं, दस्तावेज़ जनरेटर का उपयोग करके डेवलपर्स को अपने कोड को अच्छी तरह से और उचित रूप से दस्तावेज़ करने के लिए प्रोत्साहित किया जाता है (इस तरह प्रलेख स्रोत में और बाहरी डॉक्स में है, और आपको केवल इसे लिखना है एक बार)। यदि आपकी प्रोजेक्ट में कई शाखाएं हैं या आपके डेवलपर्स आपके कोड के कई अलग-अलग संस्करणों पर काम कर रहे हैं, तो एक दस्तावेज़ जनरेटर उस स्रोत कोड का जो भी संस्करण इस्तेमाल किया जा रहा है, उसके लिए दस्तावेज़ बना सकते हैं। साथ ही, स्वत: उत्पन्न किए गए प्रलेखन को बैक अप या संग्रह करने के लिए किसी भी अतिरिक्त प्रयास की आवश्यकता नहीं होती है (क्योंकि यह स्रोत कोड से फिर से बनाया जा सकता है, जिसे आप संस्करण नियंत्रण भंडार में रख रहे हैं, सही)। मेरे अनुभवों में, दस्तावेजों के इन तीन परतों को उपलब्ध कराने के लिए सर्वोत्तम परिणाम उत्पन्न होते हैं। जो लोग डॉक्स पढ़ना चाहते हैं और एपीआई सीखते हैं, ऐसा कर सकते हैं, और जो लोग ऐसा करने के बिना काफी अच्छी तरह से प्राप्त नहीं कर सकते। आपके दृष्टिकोण से, इस विधि को भी न्यूनतम प्रयासों की आवश्यकता होती है। पहली परत कुछ ऐसा है जो कई सॉफ्टवेयर प्रोजेक्ट पहले से ही कर रहे हैं। दूसरी परत आम तौर पर आपके द्वारा लिखित, सरल बनाने, और वेबसाइट या विकी को पोस्ट करने वाले कोड के खंडों के रूप में आती है। तीसरी परत को अपने दस्तावेज़ जनरेटर द्वारा अपेक्षित सम्मेलनों का पालन करने के लिए मौजूदा टिप्पणियों को पुन: प्रारूपित करने के लिए कुछ कार्य करने की आवश्यकता हो सकती है, हालांकि, Doxygen (और संभवत: अन्य) किसी भी डॉक्सिजन-प्रारूप टिप्पणियों को जोड़ दिए बिना भी एक उचित सभ्य दस्तावेज़ बना सकते हैं। उत्तर 11 जनवरी 10 बजे 16:24 क्या आप अपने उपयोगकर्ताओं को अपनी सेवाओं का उपयोग करने के लिए आवश्यक सभी जानकारी के साथ अंतिम उपयोगकर्ताओं को प्रदान करने के लिए पर्याप्त ऑटो-जनरेट करने वाले प्रलेखन उपकरण पाते हैं, नहीं, आम तौर पर इन उपकरणों द्वारा उपयोग की जाने वाली कोड टिप्पणियों से बहुत कुछ विवरण गुम है। निचे देखो। क्या आप विकी आधारित औजार को अपने एपीआई के अप-टू-डेट दस्तावेज बनाए रखने के लिए आसान और तेज़ी से खोजते हैं, नहीं, किसी व्यक्ति को दस्तावेज, आमतौर पर एक सांकेतिक शब्दों में बदलनेवाला उत्पादन करना चाहिए। कोडर्स हमेशा दस्तावेज़ीकरण पर प्रवीण नहीं होते हैं, जो एक विकी प्रारूप की आवश्यकता होती है। निचे देखो। साथ ही, एक विकी आपके एपीआई के कई संस्करणों के दस्तावेज के लिए आपकी ज़रूरत नहीं चाहती है। क्या आपने कोई भी टूल्स या तकनीकों को पाया है जो दोनों दुनिया का सर्वोत्तम प्रदान करती हैं - स्वचालन और लचीलेपन कोई भी उपकरण मौजूद है जो दस्तावेज़ीकरण की प्रक्रिया को सरल करता है एपीआई स्रोत नियंत्रण प्रबंधन कई अन्यों के बीच डार्क्स या गीट महान एपीआई दस्तावेज बनाने में आपको कौन सा उपकरण और तकनीक सबसे अधिक उपयोगी पाते हैं बस डालते हैं: अपने एपीआई दस्तावेज को कोड बनाओ। ज्यादातर लोगों की सबसे बड़ी गलती है कि वे दस्तावेजों को लिखने के लिए कोडर्स पूछें। इसकी तरह एक दस्तावेज़ीकरण लेखक को कोड में पूछना। यह अनिवार्य नहीं है कि एक या दूसरे इसे नफरत करते हैं (हालांकि यह बहुत अच्छी तरह से मामला हो सकता है), लेकिन इसके बजाय वे इस पर कुशल नहीं हैं। यह उनकी मुख्य योग्यता नहीं है इसलिए आप जो उपकरण या सर्वोत्तम तरीकों के बावजूद, कम गुणवत्ता वाले आउटपुट प्राप्त करने जा रहे हैं क्योंकि एक कोडर लिखित दस्तावेज में विशेषज्ञ नहीं है। हालांकि, एओआई दस्तावेजीकरण के लिए एक संहिता एक सबसे अच्छा अनुकूलन है। इस प्रकार, आपको एपीआई को कोडिंग के एक फ़ंक्शन का दस्तावेजीकरण करना चाहिए। अब ज्यादातर लोग इसे दूर तक कहते हैं और कहते हैं, महान, कोड टिप्पणियों का उपयोग करें और ऑटो उन टिप्पणियों से हमारे एपीआई दस्तावेज उत्पन्न करते हैं। अच्छा नहीं। अब आप एपीआई दस्तावेज को डिलिवरेबल के रूप में नहीं समझ सकते। यह कोड में ही एकीकृत है, और आप कोड आधार को छूने के बिना इसे संशोधित नहीं कर सकते। कॉडर्स टिप्पणी के बगल में कोड देखेंगे, और लगता है कि कोड स्वयं को स्पष्ट करता है और कम से कम (शायद अवचेतन) टिप्पणी के दस्तावेजीकरण विवरण, अलग-अलग चेतावनियों को संबोधित नहीं करता है, जो स्वयं को स्पष्ट नहीं करते हैं, जब तक कि आप कोड को देख नहीं पाते हैं कई अन्य कारणों में से, वे उस रास्ते से बचने के लिए कुछ हैं। इसलिए, जो मानसिकता की जरूरत है, वह इस तरह से बनती है: कोड प्रोजेक्ट के रूप में एपीआई दस्तावेज़ीकरण का इलाज करें। कॉडर्स को एपीआई दस्तावेज़ीकरण कोड तक पहुंचने में सक्षम होना चाहिए और वे जितनी आसानी से कोडिंग कर रहे हैं, इसका मतलब है कि यह एक सादा पाठ फ़ाइल में होना चाहिए जो कि उनके पसंदीदा संपादकीय विकास पर्यावरण में संपादित किया जा सकता है। सांकेतिक शब्दों का शुद्धिकरण और एक कंपाइलरभाषा के समापन के लिए उपयोग किया जाता है। इसलिए किसी टेम्पलेट सिस्टम का उपयोग करें जो आवश्यक सामग्री क्षेत्रों को लागू करता है और लागू करता है मूल XML एक शुरुआत है एपीआई दस्तावेज़ीकरण परियोजना के हिस्से के रूप में अनुवाद लिपियों को (जो भी हो) में रखें, और उन स्क्रिप्ट पर सुधार करने के लिए कोडर्स को प्रोत्साहित करें। अर्थात् उन्हें उन्हें खेलने के लिए कुछ देना। (वैकल्पिक, लेकिन वास्तव में लंबे समय में बेहतर दस्तावेज बनाने में मदद करता है) प्रत्येक एपीआई सुविधा को अपनी स्वयं की स्रोत फाइल में प्रलेखित किया जाना चाहिए। एक फाइल में एक से अधिक दस्तावेज़ इकाई न रखें। यह फ़ोकस सामान्य और स्पष्ट करता है क्योंकि सांकेतिक शब्दों में कहें दस्तावेज़ीकरण में फंसने से बचने के लिए। एक सामान्य परियोजना की तरह कार्य, मील के पत्थर आदि सेट करें। एपीआई दस्तावेज़ पूरी तरह से आपके मुख्य प्रोजेक्ट में शामिल नहीं है जो कि आप दस्तावेज कर रहे हैं। यह वैधता देने और आउटपुट पर ध्यान केंद्रित करने में मदद करता है और इसे पक्ष की ओर या कम से कम करने से बचने में मदद करता है - ओह, हमें दस्तावेज़ की खाँसी लिखने के लिए केवल एक दिन की आवश्यकता है। बहुत ज्यादा एक मानसिकता मुद्दा, हालांकि यह एक प्रभावी दृष्टिकोण हो सकता है एक्सएमएल आउटपुट बनाने के लिए एक्सएमएल टेम्पलेट्स और सीएसएस आदानों को लेकर XSL ट्रांसफ़ॉर्मेशन का उपयोग करने के लिए मुझे एक कार्यान्वयन मिल गया है। परिणामों को देखने के लिए और आसान करने के लिए बहुत आसान है tweak यह भी आसान है कि किसी प्रलेखन के लिए दस्तावेज़ीकरण को छूने के बिना किसी डिजाइनर के लिए एक अनुकूल दृष्टिकोण का निर्माण करना आसान हो। उस दृष्टिकोण और मानसिकता को लेना, हम अब संस्करण हमारे दस्तावेज को नियंत्रित कर सकते हैं, इसे संशोधित कर सकते हैं, अपडेट जारी कर सकते हैं और डेवलपर्स इस पर काम कर सकते हैं और इसे किसी भी अन्य कोडिंग परियोजना की तरह व्यवहार कर सकते हैं। परियोजना और रिलीज के खिलाफ कीड़े प्रस्तुत की जा सकती हैं। आदि आदि। यदि आप एक अच्छा स्रोत नियंत्रण उपकरण का उपयोग करते हैं, तो एपीआई के विभिन्न संस्करणों के लिए प्रलेखन बनाए रखना एक हवा है। जवाब दिया 12 जनवरी 10 11:50 पर सारांश। प्रलेखक के द्वारा एपीआई स्टब उत्पन्न करने के लिए एक कंपाइलर का उपयोग करें। चेतावनी । एक सस्ता समाधान नहीं है, लेकिन किसने कहा था कि आजकल आपको निःशुल्क भोजन मिल सकता है संकेत एपीआई स्टब पीढ़ी कंपाइलर उत्पन्न करने के लिए फ्लेक्ससन का उपयोग करें आप ट्रैक पर हैं यदि आप अपना एपीआई अच्छी तरह से दस्तावेज करने का एक तरीका चाहते हैं। बुरा प्रलेखन के साथ अनगिनत एपीआई हैं जो उपयोगकर्ता को सीधे स्रोत (एक दुर्लभ उपयोगकर्ता) के पास जाने के लिए मजबूर करते हैं, या विकल्प छोड़ देते हैं और विकल्प ढूंढ सकते हैं। एपीआई के लिए प्रलेखन लिखने में एक बड़ी समस्या यह है कि वे समय के साथ क्रियान्वयन के साथ तुल्यकालित हो जाते हैं। जैसे एक डेवलपर को एक अतिरिक्त तर्क को स्वीकार करने के लिए एपीआई संशोधित करना, फ़ंक्शन के लिए दस्तावेज़ को अपडेट करने के लिए याद नहीं रख सकता है। इसलिए, भले ही नए एपीआई के लिए प्रलेखन उत्पन्न हो, यह वास्तविक क्रियान्वयन के साथ सिंक्रनाइज़ेशन से बाहर हो सकता है हमने इस समस्या को हमारी कंपनी में एपीआई स्टब्ब से प्रलेखन से ही हल किया है, अर्थात दस्तावेज एपीआई अंतरफलक निर्दिष्ट करता है। स्टैग जनरेशन कम्पाइलर द्वारा समझने वाले वाक्यविन्यास में डॉक्स का वर्णन किया गया है कंपाइलर यह सुनिश्चित करता है कि प्रत्येक तर्क दस्तावेज किया गया है और एपीआई का वर्णन करने वाली एक टिप्पणी है, और एक स्टब फ़ाइल और साथ ही प्रारूपित दस्तावेज भी तैयार करता है। डेवलपर्स द्वारा स्टब्स भर रहे हैं जनरेटेड perf. c फ़ाइल: जनरेटेड perf. h फ़ाइल: डेवलपर एक अलग फ़ाइल में perfcounter () लागू करता है। यह सुनिश्चित करता है कि एपीआई दस्तावेज़ीकरण हमेशा अप-टू-डेट है और प्रलेखन एक संकलक द्वारा लागू किया जाता है। बेशक, अगर आप चाहें, तो आप अब भी एपीआई को बुरी तरह से दस्तावेज कर सकते हैं, लेकिन आप कभी भी कुछ दस्तावेज को भूलना नहीं भूलेंगे। डॉक्टर की गुणवत्ता सुनिश्चित करने के लिए, हमारे पास उन लोगों का एक अलग समूह है, जो दस्तावेज़ीकरण की गुणवत्ता की समीक्षा करते हैं (डेवलपर्स के साथ काम करने के लिए वे जो दस्तावेज़ लिखने की कोशिश कर रहे हैं, और सुधार की सलाह देते हैं, आदि के लिए काम करते हैं।) यदि मैं अपने सुझाव को ठीक से समझ रहा हूं, तो चरण ( 1) दस्तावेज़ीकरण लिखें, (2) इन एपीआई दस्तावेजों से स्टबबेर्ड स्रोत कोड तैयार करें, और अंत में (3) इन जेनरेट स्टाब के कार्यान्वयन लिखिए। आप एपीआई परिवर्तनों को कैसे संभाल सकते हैं? आपको अभी भी दस्तावेज़ीकरण को स्रोत कोड के साथ सिंक्रनाइज़ेशन रखने की समस्या है पहले क्रियान्वयन के बाद ndash pix0r Jan 6 10 at 22:20 हाँ, आप सही तरीके से समझ गए जब भी एपीआई बदलता है, perf. api फ़ाइल (उपरोक्त उदाहरण में) डेवलपर द्वारा संशोधित की जाएगी। वह फिर से stubs उत्पन्न Perfcounter () के लिए पहले से मौजूद कोड एक अलग फ़ाइल में है और स्टब उत्पन्न कम्पाइलर द्वारा नहीं छुआ है। यह केवल perf. c फ़ाइल में नई परिभाषाएं उत्पन्न करता है। नई परिभाषा के अनुरूप होने के लिए, डेवलपर दूसरी फाइल में पेर्फक्क्वायर () फ़ंक्शन को बदलता है और संशोधित करता है जब डेवलपर एपीआई बदलता है, तो दस्तावेज़ीकरण (पर्फ. एपीआई) बदलता है, कम्पाइलर नए दस्तावेज को पुन: उत्पन्न करता है। ndash सुधांशु 6 जनवरी 10 22:37 पर एक महत्वपूर्ण मुद्दा यह है कि यदि आप प्रलेखन प्रक्रिया पर अधिक काम करते हैं तो आप और उसके बाद के योगदानकर्ताओं का इसका उपयोग करने की संभावना कम है। यदि आपकी परियोजना का दस्तावेजीकरण करने के लिए एक सीखने की अवस्था है, तो आप पहले से ही अपने लक्षित दर्शकों के साथ संचार के रास्ते में बाधा डाल चुके हैं प्रलेखन प्रक्रिया को बरकरार रखना एक समय लेने वाली परियोजना बन सकता है। जैसा कि बताया गया है, अलग-अलग टूल्स के साथ निर्मित अलग-अलग दस्तावेजों के साथ प्रत्येक को संबोधित करने के लिए अलग-अलग ऑडियंस हैं और इसकी उपयुक्तता है। नंगे न्यूनतम के रूप में आपको दो दस्तावेजों की आवश्यकता होती है: 10,000 फीट दस्तावेज़ से देखें जो आपके एपीआई का समर्थन करता है संरचना, सुविधाओं और प्रक्रिया का वर्णन करता है। इसका मतलब किसी भी अधिक विस्तृत दस्तावेज़ीकरण के संदर्भ देने के लिए है। कुछ उपयोगकर्ता वास्तव में आपके सभी बुद्धिमान शब्दों को पढ़ना चाहते हैं, इसलिए जब वे एक प्रश्न के साथ आते हैं मैं एक्स कैसे करूं, आपको उन्हें पता करने की आवश्यकता है घटक को देखो तो वे पीछा करने में कटौती कर सकते हैं संदर्भ दस्तावेज़ सबसे प्रभावी है यदि आप मूल संरचना (एस) को कुछ बनाने के लिए कुछ चित्र उत्पन्न कर सकते हैं जो लोग कल्पना कर सकते हैं विकल्प का भार है, लेकिन विकी ऐसे किसी दस्तावेज़ को ऐसे तरीके से होस्ट करने का एक साधन प्रदान करता है कि उपयोगकर्ता योगदान कर सकते हैं और आपको यह बता सकते हैं कि उन्हें किस क्षेत्र की जरूरत है निम्न स्तर का दस्तावेज़ जो प्रत्येक कॉल, प्रतिक्रिया, पैरामीटर और डेटाटाइप का विवरण देता है। इस तरह के दस्तावेज़ीकरण की सबसे अच्छी सुविधा यह सुनिश्चित करने के लिए है कि यह व्यापक रूप से जुड़ा हुआ है और अद्यतित है। जब मैं किसी दिए गए कॉल को देखता हूं, तो मैं हर एक डेटा प्रकार, प्रत्येक संबंधित कॉल और किसी अन्य विवरण को सिर्फ माउस क्लिक के साथ संदर्भित करने में सक्षम होना चाहता हूं। मेरे मन में, कोड में टिप्पणियों से स्वत: उत्पन्न प्रलेखन यह प्रदान करने के लिए एक आदर्श तंत्र है क्योंकि: क्रॉस रेफरेन्सिंग स्वचालित रूप से प्रबंधित किया जाता है, यह हमेशा व्यापक और अद्यतित है दस्तावेज़ को पुन: स्रोत कोड से उत्पन्न किया जा सकता है और नए रिलीज़ होने पर रिलीज के रूप में प्रलेखन कोड के बगल में बैठता है, इसे आसानी से स्वचालित कोड स्टाइल चेकर्स और कोड रिव्यूर्स के संयोजन द्वारा सत्यापित किया जा सकता है। यह सच है कि इस तरह के दस्तावेज़ीकरण को अद्यतित करने के लिए अनुशासन की आवश्यकता है, लेकिन यह ऐसा करने के लिए आवश्यक प्रयास को कम करता है (जब आप कोड बदलते हैं, दस्तावेज़ीकरण सही है और आसानी से संपादन योग्य है) और सरल पाठ टिप्पणी पर रिटर्न को अधिकतम करता है। जेवाडॉक के माध्यम से कोर कक्षाओं के संगत और सहज ज्ञान युक्त दस्तावेज़ों में जावा का एक कारण इतनी जल्दी सफल हो गया। अगर आपकी एपीआई एक चल रही परियोजना है, तो सहयोगी उपकरण जैसे कि विकी, फोरम या एपीआई दस्तावेज के लिए मेलिंग सूची का उपयोग करने से आप अपने अंतिम उपयोगकर्ताओं को शामिल करने की अनुमति दे सकते हैं और समझ सकते हैं कि उन्हें आपके समर्थन की आवश्यकता है। उम्मीद है कि यह बहुत लोकप्रिय होगा कि प्रयोक्ता स्वयं एक समुदाय का समर्थन और निर्माण शुरू कर देंगे जो परियोजना को दस्तावेज बनाने के अपने प्रयासों से परे हो। आप महान एपीआई दस्तावेज बनाने में कौन से उपकरण और तकनीक सबसे उपयोगी पाते हैं, मैंने किसी भी महान एपीआई दस्तावेज़ीकरण को बनाया है, लेकिन Ive कुछ का इस्तेमाल किया है सबसे बहुमूल्य उपकरण और तकनीक का सामना करना पड़ रहा है, दस्तावेज़ीकरण के लिए पूर्ण उदाहरण शामिल होंगे, जो कि सरल हैं, वास्तव में काम करते हैं, और यह कि उपयोगकर्ता उपयोगकर्ता के साथ बातचीत कर सकते हैं। सबसे शानदार एपीआई दस्तावेजों में से एक मैंने कभी पढ़ा है I जो पिछले मैनुअल पढ़ने के बाद से दो मैनुअल में विभाजित है। एक प्रारंभिक मसौदा (2006) लगभग 700 पृष्ठों लंबा था और 300 से अधिक पूर्ण व्यावहारिक उदाहरण हैं, जिनमें से प्रत्येक तुरंत लोड हो सकता है और साथ में बातचीत कर सकता है। यह बहुत अमीर, जटिल एपीआई सीखने के लिए एक आश्चर्यजनक सहायता थी एक और तकनीक Ive एक सहायक के रूप में बहुत मददगार पाया कुछ डॉन नुत लगातार अपने दस्तावेज के साथ है: वह व्यायाम भी शामिल है, और हर व्यायाम का जवाब किताब के पीछे है 12 जनवरी को 2:20 पर उत्तर दिया गया 20 बहुत उपयोगी सुविधाएं हैं जो आपको एक पूर्ण और अद्यतन एपीआई दस्तावेज लिखने और बनाए रखने की अनुमति देते हैं। बेशक, आप आसानी से एक सरल खोज (डॉक्सिजन, जवाडोक, आरडीओक, आदि) द्वारा पा सकते हैं, हालांकि, उरी ऊपर बताए हुए के रूप में, लोगों को केवल संक्षिप्त और एक पैकेज या एपीआई का उपयोग करने की आवश्यकता है। क्या लिखना है, और इसे कैसे लिखना है, इसके बारे में सोचकर, यह मेरे दिमाग में सबसे उपयोगी मदद मिली जिसे मैंने याद किया था अधिकांश पर्ल मॉड्यूल दस्तावेज में एक सिन्नोपिस भाग होता है। यह लाइब्रेरी या एपीआई के साथ एक असली स्टार्टर है जो मुझे आश्चर्यजनक रूप से पाया गया है, कहते हैं, स्वचालित रूप से उत्पन्न एपीआई दस्तावेजों में (उदाहरण के लिए क्यूटी या कुछ जेवाडोक जनरेटेड जावा पैकेज)। जब आप कहते हैं कि आपको क्या लगता है, तो आपको ध्यान में रखिए: आपको पता है कि क्या उम्मीद है, और आपको इस बिंदु पर एक उदाहरण मिल जाएगा: बेशक, इसके बाद आपके पास एक पूर्ण एपीआई दस्तावेज़ीकरण, चेतावनियां, अपवाद, नियम, सुझाव, आदि हैं लेकिन इसके लिए मुझे, सूचना के इस टुकड़े में एपीआई दस्तावेज के मुकाबले अधिक मूल्य है। जैसा कि आपको पैकेज की अधिक कार्यक्षमता की आवश्यकता है, आप निश्चित रूप से दस्तावेज पढ़ सकते हैं, या यहां तक ​​कि जब आप देखते हैं कि उदाहरण कोड कुछ ऐसा करता है जिसे आपको थोड़ा अलग है, तो आप जानते हैं कि एपीआई बिट (फ़ंक्शन, विधि, आदि) आपको क्या करना है संभव रूपांतरों को देखने के लिए देखो एपीआई के जो भी तत्वों में 6 जनवरी 2010 को 6:06 उत्तर दिया गया, स्वयं स्पष्टीकरण के लिए नामकरण किया गया। इन तत्वों के स्पष्ट और संक्षिप्त प्रलेखन प्रलेखन को एपीआई डिज़ाइन के परिणाम के रूप में नहीं बनाया जाना चाहिए, लेकिन प्रोजेक्ट्स दीक्षा में निर्दिष्ट कार्यात्मक आवश्यकताओं के आधार पर। यह दस्तावेज तब तक अप्रासंगिक है जब दस्तावेज़ीकरण अपडेट हो जाता है। उत्तर 8 जनवरी 10 12:22 पर प्रलेखन जनरेटर दस्तावेजों के कुछ हिस्सों के बीच लिंक बनाने और लेआउट की जाँच करने के लिए महान हैं, लेकिन वे ऐसी जानकारी नहीं जोड़ सकते हैं जो वहां मौजूद नहीं है। सबसे ज्यादा सूचना का टुकड़ा गुम है: मैं क्यों चाहता हूं कि मेरे मामले में, मैं दो टूल का उपयोग करता हूं: एक विकी आपको बड़ी तस्वीर देने के लिए जानकारी के लिए कहां और कहाँ देखना चाहिए यह सामान शायद ही कभी बदलता है और सिर्फ डिजाइन निर्णयों के बारे में बताता है और संकेत देता है इसकी आसानी से संपादन योग्य लेकिन अधिकतर स्थिर बहुत सारे परीक्षण जो दिखाते हैं कि आप कोड का उपयोग कैसे कर सकते हैं। आपको उन्हें लिखने की ज़रूरत है, इसलिए उन्हें किसी भी अन्य कोड (साफ़ और पठनीय) की तरह लिख दें और उन्हें अपने उदाहरणों में बदल दें। मुख्य लाभ: दस्तावेज़ीकरण गलत हो सकता है या पुराना हो सकता है। टेस्ट हमेशा सत्य बताएं (टीएटीटीटी) और हमेशा याद रखें: बस एक लाइन की तरह, पाठ की एक पंक्ति को बनाए रखा जाना चाहिए। इससे भी बदतर, पाठ की एक पंक्ति इसे जांचने के लिए कंपाइलर के साथ नहीं आती। इसलिए प्रलेखन को यथासंभव कम (लेकिन कम नहीं) रखें। उत्तर दिया 13 जनवरी 10 बजे 8:56 क्रिस: कोड के लिए लिंक: I39m उस पर काम कर रहा है ऐसा करने के लिए, विकी परियोजना का अभिन्न अंग बनना चाहिए। मैलेन विकी टेक्स्ट एक अच्छा विकल्प है लेकिन लिंकिंग एक कमजोर स्थान है (यह लिंक कर सकता है लेकिन कोड में लिंक बनाने के लिए कुछ कोड अनुपलब्ध है और यह जांचता है कि लिंक अभी भी काम करते हैं, आदि)। प्लस यह वर्तमान में केवल ग्रहण टीओसी के लिए: नहीं। मुख्य पृष्ठ में 1039000 फीट देखने वाले अधिक विस्तृत पृष्ठों के लिंक्स हैं। शेष विकी की अंतर्निहित खोज के साथ मिल सकते हैं ndash Aaron Digulla 13 जनवरी 10 10:03 पर Im वर्तमान में Sandcastle मदद फ़ाइल बिल्डर का उपयोग कर रहा है यह विंडोज के लिए एक उपकरण है, जो एमएसडीएन-स्टाइल दस्तावेज़ को XML प्रलेखन टिप्पणियों से उत्पन्न कर सकता है जो आप अपने स्रोत कोड में एम्बेड करते हैं। यह स्वत: जनरेटेड सामग्री अच्छी है, लेकिन पर्याप्त नहीं है: आपको परिचयात्मक अनुभाग भी चाहिए, जो संपूर्ण रूप से सॉफ़्टवेयर प्रस्तुत करते हैं, इसे कैसे स्थापित करें, शायद विभिन्न उपयोग मामलों के लिए ट्यूटोरियल हैं, आदि। आप इस प्रकार के लेखक के लिए एसएचएफबी का उपयोग कर सकते हैं। सूचना का भी: एसएचएफबी इसे संकल्पनात्मक सामग्री कहते हैं, और आप इसे एमएएमएल स्कीमा का उपयोग करके इसे चिह्नित करते हैं। वैचारिक सामग्री के भीतर से जो आप लिखते हैं, आप आसानी से एपीआई संदर्भ दस्तावेजों के किसी भी पेज पर हाइपरलिंक कोड कर सकते हैं। इसके अलावा, हालांकि वैचारिक सामग्री की सामग्री आपके ऊपर निर्भर है, इसकी सामग्री एचटीएमएल के समान एपीआई संदर्भ के रूप में उपयोग की जाती है: उदाहरण के लिए यदि एपीआई संदर्भ दस्तावेज (कोड में टिप्पणी से जेनरेट किया गया) का पृष्ठ ऐसा दिखता है । और वैचारिक सामग्री का पृष्ठ (एमएएमएल के जरिए लिखा हुआ) इस तरह दिखता है उपकरण नेविगेशन की मदद के लिए सामग्री की एक तालिका भी तैयार की है। Ive ज्यादातर एमएसडीएन प्रलेखन पर्याप्त है, तो संभवतः एक toolset जो उत्पन्न कर सकते हैं MSDN तरह प्रलेखन पर्याप्त भी है Ive उत्तर 13 जनवरी 10:31 बजे 7:31 2017 स्टैक एक्सचेंज, इंक