पीएचपी NetBeans 7.01 में phpDocumentor का उपयोग करके ऑटो-प्रलेखन, बताना, कस्टमाइज़ करना, ठीक करना

इस लेख में आप नए और पुराने ज्ञान प्राप्त करेंगे, विशेष रूप से, उनमें से कुछ हाल ही में RuNet में दिखाई दिए, और कुछ को आम तौर पर बॉक्स ऑफिस छोड़ने के बिना सीधे मौके पर पेश किया गया था।

तो आप जानेंगे:

• ऑटोडेक्जामेशन क्या है और यह PHP में कैसे किया जाता है, इस बारे में बुनियादी जानकारी
• NetBeans 7.01 में phpDocumentor प्रलेखन जनरेटर की स्थापना
• मेरे द्वारा किए गए phpDocumentor लाइब्रेरी से लिंक किए गए परिवर्तनों की एक सूची के साथ सही है, मुझे लगता है कि कुछ को तुरंत इसकी आवश्यकता हो सकती है
• लिंक पढ़ें

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

यदि आप रुचि रखते हैं, तो बिल्ली में आपका स्वागत है

---

कुछ नहीं जानते कि ऑटोडेक्जामेशन क्या है। कई लोग आकार के कारण इसका उपयोग नहीं करते हैं, एक या दो लाइनों में पुराने ढंग से कोड पर टिप्पणी करते हैं, या बिल्कुल भी टिप्पणी नहीं करते हैं। यह कई जो पाप करते हैं और मैं, कभी-कभी =)। उदाहरण के लिए, एक अन्य अल्प विवरण के बीच, मेरी पसंदीदा टिप्पणी 800-सौ लाइन फ़ाइल के शीर्षक में है:

//   :      ,     . 

PHP में ऑटो प्रलेखन क्या है

ऑटो प्रलेखन एक कार मैनुअल ऐसी चीज़ है जो आपको कोड पर टिप्पणी लिखने की अनुमति देती है। उसी समय, आईडीई के अंदर, कोड, विधि, फ़ंक्शन, फ़ाइल, आदि पर युक्तियां प्रदर्शित की जाएंगी। आगे, इसके आधार पर, किसी भी HTML, पीडीएफ, एक्सएमएल प्रारूप आदि में पूरे कोड के लिए पूर्ण प्रलेखन उत्पन्न करना संभव है। उदाहरण के लिए, MSDN में - जो कुछ भी आप तालिका में देखते हैं वह प्रोग्रामर के हाथों से ऑटो-डॉक्यूमेंटेशन का उपयोग करके बनाया जाता है। प्रलेखन विभाग द्वारा अन्य सभी चीजों की निगरानी की जाती है, जो अतिरिक्त चबाने और उदाहरण लिखते हैं।

PHP के लिए प्रलेखन की पीढ़ी के संबंध में, विभिन्न पुस्तकालय हैं। सबसे दिलचस्प जो मुझे मिला:

• Doxygen
• phpDocumentor
• docblox - यूपीडी
• phpdoctor - यूपीडी

मैंने PHPDocumentor का उपयोग करने का निर्णय लिया। इस पुस्तकालय का कार्य मुझे पूरी तरह से संतुष्ट करता है, विशेष रूप से इसमें मेरे संपादन के बाद।

उदाहरण

- कोड

 /** *        * * @param int $arVarOne * @param int $arVarTwo * @return string */ function sum_return_string($arVarOne, $arVarTwo) { $result = $arVarOne + $arVarTwo; return "$result"; //  !!! } 

- आईडीई टिप्स: हम यह पता लगाएंगे कि फ़ंक्शन स्पष्ट रूप से एक स्ट्रिंग वापस नहीं करता है


- ऑटो प्रलेखन:

---

एक PHPDocumentor ऑटो-दस्तावेज़ स्क्रिप्ट सेट करना

मैं खिड़कियों के नीचे काम करता हूं। मेरे पास xampp है - यह उन लोगों के लिए एक बहुत ही सुविधाजनक चीज है जो नहीं जानते थे, लेकिन इसमें पूर्व-कॉन्फ़िगर PHPDocuoror नहीं है। उदाहरण के लिए, पूर्व-कॉन्फ़िगर PHPUnit है। हम xampp के रचनाकारों को दोष नहीं देंगे, लेकिन मैन्युअल कॉन्फ़िगरेशन पर आगे बढ़ेंगे। कोई फर्क नहीं पड़ता कि वे पीईएआर जैसी स्मार्ट टीमों के बारे में कहां लिखते हैं, यह मेरे लिए बेहतर है। मैं अपने आप से यह जोड़ता हूं कि मैं स्वयं इसे इस तरह से वर्णन करना पसंद करता हूं कि यह सभी निरपेक्ष रास्तों के साथ वर्णन के अनुसार 100% काम करता है, इसलिए आप यह सुनिश्चित कर सकते हैं कि यदि आप इसे पसंद करते हैं तो यह काम करेगा:

- प्रारंभिक स्थापना
XAMPP को D: \ xampp निर्देशिका में कॉन्फ़िगर किया गया है

अगर डी में क्या हुआ: \ xampp \ php \ PEAR \ PhpDocumentor हम डरते नहीं हैं और इसे हटा दें। Xampp से कोई स्मार्ट कॉन्फ़िगरेशन नहीं हैं।

- डाउनलोड कोड
हम PEAR आदेशों के बारे में नहीं सोचते हैं, डेवलपर की साइट से PHPDocumentor को सीधे डाउनलोड करें (नीचे लिंक दिए गए हैं) मेरे पसंदीदा संस्करण हैं)
PEAR निर्देशिका में सब कुछ अनपैक करें। आपको निर्देशिकाओं पर कुछ जादुई संचालन करने की आवश्यकता होगी: अनावश्यक पदानुक्रमों को हटाना, नाम बदलना आदि। परिणामस्वरूप, फ़ाइल और पदानुक्रम, विशेष रूप से, phpdoc.bat फ़ाइल इस निर्देशिका में होनी चाहिए: D: \ xampp \ php \ PEAR \ PhpDocumentor

- लाइब्रेरी की स्थापना
अब आपको लाइब्रेरी को स्वयं कॉन्फ़िगर करने की आवश्यकता है। ऐसा करने के लिए, phpdoc.bat फ़ाइल पर जाएं
इसमें, हम अपने स्थापित PHP दुभाषिया के लिए मार्ग का संकेत देंगे, साथ ही साथ काम करने वाली निर्देशिका को स्विच करेंगे।

बजाय:
SET phpCli = C: \ usr \ local \ php \ cli \ php.exe

सम्मिलित करें:
SET phpCli = D: \ work \ rumb-software \ xampp \ php \ php.exe
सीडी / डीडी: \ xampp \ php \ PEAR \ PhpDocumentor

चेतावनी रीफ़!
यदि आप XAMPP को C से अलग ड्राइव पर रख रहे हैं: तो जब आप निर्देशिका (CD कमांड) का चयन करते हैं, तो आपको / D तर्क जोड़ने की आवश्यकता है - यह सोचते हुए कि "स्क्रिप्ट देखने के लिए क्यों नहीं गया?" गलती से यह माइक्रोसॉफ्ट-मैजिक याद आ रहा है।

- IDE कॉन्फ़िगर करें
अब इस एक्सटेंशन के साथ काम करने के लिए IDE कॉन्फ़िगर करें।

ऐसा करने के लिए, पर जाएं
नेटबींस 7.01> विकल्प> PHP> PHPDoc> PhpDoc स्क्रिप्ट

यह लाइन डालें:
D: /xampp/php/PEAR/PhpDocumentor/phpdoc.bat -o HTML: फ़्रेम: अर्थली

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

ध्यान देने की स्थिति!
स्लैश एक सीधा "/" होना चाहिए। यदि आप ब्राउज़ के माध्यम से चयन करते हैं, तो NetBeans एक बैकस्लैश स्थानापन्न करेगा।

- अब उस पथ को सेट करें जहां प्रलेखन सहेजा जाएगा

हम PHP जैसी परियोजना बनाते हैं, ठीक है, मैं यहां इसका वर्णन नहीं करूंगा। मान लें कि मैंने इसे उदाहरण-परियोजना कहा है और इसे D: / xampp / htdocs / example-project, PHP संस्करण 5.3 UTF-8 एन्कोडिंग में डाल दिया है

किसी प्रोजेक्ट पर राइट क्लिक करें
उदाहरण-प्रोजेक्ट> गुण> PhpDoc> लक्ष्य निर्देशिका
लाइन डालें ( स्लैश के साथ एक समस्या भी है! ):
डी: / xampp / htdocs / phpdoc

- लॉन्च करें
इन क्रियाओं के बाद, प्रोजेक्ट> जनरेट PhDDoc पर राइट-क्लिक करके जेनरेशन उपलब्ध है।

शामिल पथ में भी, आप प्राप्त प्रलेखन की निर्देशिका को कनेक्ट कर सकते हैं ताकि आईडीई के माध्यम से फाइलें दिखाई दें। वास्तविकता में, यह आमतौर पर आवश्यक नहीं है, लेकिन आनंद =)

---

मेरे द्वारा तय की गई लाइब्रेरी में कई समस्याएं

पीढ़ी की प्रक्रिया में, मैं कई समस्याओं से मिला।

- नोटिस पॉप अप
डिफ़ॉल्ट रूप से, डेवलपर PHP में, मेरे पास त्रुटियों, चेतावनियों, नोट्स और स्ट्रिंग्स का अधिकतम स्तर है। प्रलेखन पीढ़ी के दौरान, इन सभी त्रुटियों को फाइलों में गिरना शुरू हो गया, मूल रूप से उन्होंने अपनी स्मार्टी क्लास बनाई, मैं PHPDocumentor डेवलपर्स के लिए सम्मान व्यक्त करता हूं - वे ठीक कर रहे हैं। मैंने इस समस्या को पुस्तकालय में जबरन रखने पर प्रतिबंध लगा दिया।
जोड़ा गया error_reporting (E_ERROR); फ़ाइल में
डी: \ xampp \ php \ PEAR \ PhpDocumentor \ phpDocumentor \ phpDococ.c

- एन्कोडिंग मुद्दा
मैं थोड़ा रूसी हूं और रूसी टिप्पणियां लिखना पसंद करता हूं। एन्कोडिंग समस्याएँ हुई हैं। यहां मेरे पास उदाहरण के लिए UTF-8 है, और लाइब्रेरी में एक और एन्कोडिंग iso-8859-1 जेनरेशन टेम्प्लेट में सीवन किया गया था। परिणाम बकवास था। स्मार्टी कैसे काम करता है, यह जानने के बाद, मैंने कोड के साथ 3-4 फाइलें तय कीं और टेम्प्लेट में एक डायनामिक चर दर्ज किया। अब आउटपुट टेम्प्लेट की एन्कोडिंग को मैन्युअल रूप से फाइल D में बदला जा सकता है: \ xampp \ php \ PEAR \ PhpDocumentor \ phpDocumentor \ phpdoc.inc CHARSET स्थिरांक का उपयोग करते हुए, यदि आवश्यक हो, तो चर {$ charset} को पूरे सेट से किसी भी टेम्पलेट में जोड़ा जा सकता है, मैंने चार्ट को देखा। हेडर सभी टेम्पलेट्स में नहीं हैं।

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

---

सामग्री लिंक

PHPDocumentor लाइब्रेरी लिंक:
http://sourceforge.net/projects/phpdocu/files/

सही PHPDocumentor: यदि यह लोड नहीं होता है, तो PM से संपर्क करें। शायद मैंने अपना खराब सर्वर फिर से डाल दिया।
http://yadi.sk/d/7WnrUy5z0qE7n

प्रलेखन के लिए लिंक PhpDoc प्रारूप पर:
http://manual.phpdoc.org/HTMLframesConverter/default/

विदेशी वीडियो - सेटअप निर्देश:
http://netbeans.org/kb/docs/php/screencast-phpdoc.html

स्लैश के साथ समस्या और इस मामले में क्या त्रुटि होगी, यहां वर्णित है:
pachkov.ru/?p=1222

खोज इंजन द्वारा अनुक्रमण के लिए पाठ:
PhpDoc (विंडोज के लिए) बनाते समय नेटबीन्स में त्रुटि
फ़िल्टर करने में त्रुटि। निम्न त्रुटि संदेश उत्पन्न हुआ था:
java.util.regex.PatternSyntaxException: अवैध हेक्साडेसिमल एस्केप अनुक्रम 10 के पास
(। *) (C: \ xampp \ htdocs \ PhpProject1 \ phpdoc / त्रुटियाँ \। Html) (*)।

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

UPD: डंबल स्लीप टाइपो का एक गुच्छा तय किया

UPD2: मुझे समझ में नहीं आता कि कौन कर्म का विलय करता है, मैं पुनर्लेखन नहीं लिखता, और लेख पूरी तरह से तकनीकी है और समग्र नहीं है। कर्म में परिवर्तन की गुमनामी को पूरी तरह से दूर करना आवश्यक है, ताकि जनता को परीक्षण पर रखा जा सके। मैं आश्चर्यचकित था और नाराज था, लेकिन मैं मानता हूं कि वे 15-बिंदु बाधा की शुरुआत के बाद, कम होना शुरू हो गए थे।