Docblox - PHP 5.3+ के साथ संगत प्रलेखन प्रणाली

अगली बार जब मैंने PEAR का उपयोग करके Phing को अपडेट किया , तो मैंने अतिरिक्त निर्भरताओं की एक सूची देखी और उन परियोजनाओं की साइटों पर जाने का फैसला किया जिनके नाम मुझे कुछ भी नहीं बताते थे। अन्य बातों के अलावा, मुझे एक आशाजनक परियोजना मिली जिसे मैं आपके साथ साझा करना चाहूंगा। मैं आपके लिए Docblox प्रस्तुत करता हूं - PHP अनुप्रयोगों के दस्तावेजीकरण के लिए एक नई प्रणाली जो प्रसिद्ध PHP वृत्तचित्र में सन्निहित विचारों को विकसित करती है। फिलहाल, PEAR अंकन के अनुसार, परियोजना बीटा परीक्षण में है, लेकिन इसका उपयोग पहले से ही Zend फ्रेमवर्क , फिंग , ईंधन और कुछ अन्य जैसे परियोजनाओं के विकास में किया जाता है।

PHP डॉक्यूमेंटर की तुलना में नई सुविधाएँ:

1. नाम स्थान का समर्थन
2. कुछ नए @ -टैग: एपि , मैजिक , @ प्रॉपर्टी-रीड, @ प्रॉपर्टी-राइट, @throws
3. बच्चे की कक्षाओं में विधि विवरणों को प्राप्त करने की क्षमता (जब खाली डॉकब्लॉक जोड़ते हैं, तो विवरण माता-पिता वर्ग / इंटरफ़ेस से कॉपी किए जाते हैं)
4. साधारण पाठ स्वरूपण के लिए समर्थन जैसे विकी मार्कडाउन (मार्कडाउन सहित)
5. परिवर्तित फ़ाइलों को ट्रैक करना (प्रसंस्करण में तेजी है, क्योंकि केवल परिवर्तित फ़ाइलें देखी जाती हैं)
6. एक मध्यवर्ती XML फ़ाइल के माध्यम से दो-चरण प्रलेखन पीढ़ी, जिसके आधार पर HTML पृष्ठ उत्पन्न किए जा सकते हैं। XML फ़ाइल की सामग्री में स्रोत कोड से निकाली गई सभी जानकारी शामिल है, और इसका उपयोग प्रोग्रामर अपने विवेक से कर सकता है।
7. बिल्ड के लिए XML. कॉन्फ़िगरेशन के साथ XML फ़ाइलों के लिए समर्थन। Phing के लिए, आपको मानकों के साथ docblox कमांड चलाकर प्रलेखन उत्पन्न करने की अनुमति देता है।
8. विषयों और सामग्री प्रदर्शन टेम्पलेट्स के लिए समर्थन
9. एक्सएमएल डेटा को एक मनमाना प्रारूप फ़ाइल में निर्यात करने के लिए कस्टम कक्षाएं जोड़ने की क्षमता
10. पीडीएफ उत्पन्न करने की क्षमता (अतिरिक्त लाइब्रेरी wkhtmltopdf की आवश्यकता है , HTML → PDF कन्वर्ट करने के लिए WebKit का उपयोग करके लिखा गया है)
11. प्रत्येक वर्ग के लिए एक यूएमएल जैसा ग्राफ उत्पन्न करने की क्षमता (ग्राफविज़ आवश्यक)

स्थापना:

परियोजना का अपना PEAR चैनल है, इसलिए स्थापना प्राथमिक रूप से सरल है:

# pear channel-discover pear.docblox-project.org # pear channel-discover pear.michelf.com # pear install DocBlox/DocBlox-beta (-beta   ,  beta-     ) 

प्रलेखन पीढ़ी:

 $ docblox run 

यदि यह docblox.dist.xml या docblox.xml फ़ाइल में है, तो इसे स्रोत फ़ोल्डर में निष्पादित किया जाता है। अन्यथा, कोई त्रुटि है।

 $ docblox run --config /path/to/docblox.xml 

यदि कॉन्फ़िगरेशन फ़ाइल वर्तमान निर्देशिका में नहीं है।

 $ docblox run --filename /path/to/file1,/path/to/file2 

यदि आपको अलग-अलग फ़ाइलों को सूचीबद्ध करने की आवश्यकता है।

 $ docblox run --directory /path/to/src1,/path/to/src2 --target /path/where/to/save/docs 

आप स्रोत कोड वाली फाइलों के लिए खोज निर्देशिकाओं को स्पष्ट रूप से निर्दिष्ट कर सकते हैं और निर्देशिका जहां समाप्त प्रलेखन लिखा जाएगा। सभी संदर्भित निर्देशिकाएं मौजूद होनी चाहिए।

 $ docblox run --help 

आप Docblox के कुछ अन्य विकल्पों को देख सकते हैं, जिन्हें सहायता कहा जाता है।

उदाहरण docblox.dist.xml या docblox.xml कॉन्फ़िगरेशन फ़ाइल:

 <?xml version="1.0" encoding="UTF-8" ?> <docblox> <!-- 1)  \    (  *  ?) --> <files> <directory>src</directory> <directory>tes??</directory> <file>test.php</file> <file>bin/*</file> <ignore>test/*</ignore> </files> <!-- 2) ,     --> <parser> <!-- 2.1)    XML- --> <target>src/docs/xml</target> <!-- 2.2)     @package     --> <default-package-name>core</default-package-name> <!-- 2.3)     ,  ,   --> <markers> <item>TODO</item> <item>FIXME</item> </markers> <!-- 2.4)        --> <extensions> <extension>php</extension> <extension>php3</extension> <extension>phtml</extension> </extensions> </parser> <!-- 3) ,     XML-     --> <transformer> <!-- 3.1)     --> <target>src/docs/html</target> <!-- 3.2)          Std_Class--> <external-class-documentation> <prefix>Std_Class</prefix> <uri>http://external-project.org/docs/latest/</uri> </external-class-documentation> </transformer> <!-- 4)        --> <transformations> <template name="Crystal-Blue" /> </transformations> <!-- 5)    --> <logging> <!-- 5.1)    (   ,    PHP) --> <level>warn</level> <!-- 5.2)     (default)      (errors).  {APP_ROOT}      , {DATE} —    --> <paths> <default>{APP_ROOT}/data/log/{DATE}.log</default> <errors>{APP_ROOT}/data/log/{DATE}.errors.log</errors> </paths> </logging> </docblox> 

संदर्भ:

• http://www.docblox-project.org/ - प्रोजेक्ट साइट
• http://demo.docblox-project.org/ - जनरेट किए गए दस्तावेज़ का एक उदाहरण (प्रत्येक फ़ोल्डर प्रलेखन अनुप्रयोगों की एक अलग उपस्थिति का उपयोग करता है)
• http://github.com/mvriel/docblox - गिटहब पर भंडार
• http://twitter.com/docblox - ट्विटर पर माइक्रोब्लॉगिंग परियोजना

फिलहाल, डॉकबॉक्सी का सबसे हालिया संस्करण 0.13.3 है, जिसे अगस्त 2011 के अंत में जारी किया गया था। साइट के संदेशों को देखते हुए, संस्करण 0.14 को रिलीज़ के लिए तैयार किया जा रहा है।