2012-01-02 19 views
6

मैंने पहले कभी भी अपना कोड दस्तावेज करने के बारे में बहुत ज्यादा परवाह नहीं की, लेकिन हाल ही में मैंने ओपन सोर्स प्रोजेक्ट पर काम करना शुरू कर दिया और जरूरत उठ गई। जाहिर है, 'पसंद का हथियार "PHPDoc है, लेकिन ...PHPDoc की स्थिति क्या है?

मुझे वास्तव में PHPDoc मानक का एक भी विनिर्देश नहीं मिल सका। वहां कुछ विकिपीडिया प्रविष्टि सूचीबद्ध हैं और कुछ phpDocumentor प्रोजेक्ट है, जो phpDocumentor प्रोजेक्ट है, माना जाता है कि एक और व्यापक शब्दकोश है, लेकिन PHPDoc की निश्चित मार्गदर्शिका कहां है, जहां कोई पहेली है? क्या कोई एकल मानक है या यह उन सभी phpDocumentor knockoffs पर निर्भर करता है जो PHPDoc "मानक" (यदि कोई हो) को जो कुछ भी लगता है फिट।

यदि हम मानते हैं कि phpDocumentor वह जगह है जहां PHPDoc मानक बनाया और बनाए रखा जाता है, तो चीजें बहुत गंभीर लगती हैं, क्योंकि the project's website लगभग 4 वर्षों से मर चुका है। और मुझे और भी पहेली क्या है महीने पहले एक संस्करण 1.4.4 अचानक phpDocumentor की पियर साइट पर मृतकों से दिखाई दिया।

मुझे पता है कि यहां बहुत अधिक बुद्धिमान और जानकार साथी हैं, इसलिए मैं जानना चाहता हूं। PHPDoc के साथ सौदा क्या है। क्या कोई एकल प्राधिकरण मानक बनाता है? यह कितना विश्वसनीय है? वहाँ किसी भी भविष्य है या हम एक ज़ोंबी के साथ काम कर रहे हैं और सभी आशा खो दिया है ...

धन्यवाद, इवो

+0

स्टैक ओवरफ़्लो –

+8

@ डैगन - मैं अलग-अलग होना चाहता हूं। यह [व्यावहारिक, उत्तरदायी समस्याओं के तहत आता है जो प्रोग्रामिंग पेशे के लिए अद्वितीय हैं]] (http://stackoverflow.com/faq)। –

+3

संदर्भ के लिए, थोड़ी देर में अपडेट नहीं की जा रही साइट साइट (या उस मामले के लिए परियोजना) "मृत" नहीं बनाती है। यह सिर्फ इतना हो सकता है कि 3 साल से अधिक के लिए एक नया संस्करण * आवश्यक * नहीं किया गया है, क्योंकि सॉफ्टवेयर इसकी बात करता है और यह अच्छा करता है। – cHao

उत्तर

1

यह प्रश्न पहले से ही पुराना है, लेकिन जानकारी के लिए, मुझे यह जोड़ना चाहिए कि डॉकब्लॉक्स को PhpDocumentor के साथ विलय कर दिया गया था।

की घोषणा करते phpDocumentor 2 - वर्ष (phpDocumentor) के विलय और नए (DocBlox)।

phpDocumentor (2.0.0a1) के पहले अल्फा रिलीज के साथ

, नई "उत्तरदायी" डिफ़ॉल्ट टेम्पलेट एक नया पेज लेआउट खेल, उपयोगी लेआउट सुधार है कि मूल DocBlox टेम्पलेट्स प्रदान की (जो उपलब्ध रहते हैं) के साथ पुराने phpDocumentor टेम्पलेट्स पर (जो पुराना phpDocumentor से रिटायर होगा)। http://demo.phpdoc.org/Responsive/index.html पर इस नए टेम्पलेट का अन्वेषण करें।

=>http://www.docblox-project.org/2012/03/docblox-is-unmasked-it-is-really-phpdocumentor-2/

phpdoc वापस कार्रवाई करने के लिए है। =)

2

विकिपीडिया it's dead के अनुसार।

PhpDoc टैग के लिए मानक के लिए विनिर्देश PHPPocumentor के लिए प्रलेखन में सूचीबद्ध था। लेकिन जैसे मैंने कहा, यह मर चुका है। चूंकि डॉकब्लॉक्स उस शून्य को भर रहा है जो PhpDocumentor को छोड़ दिया गया है, तो मैं DocBlox documentation का उपयोग करके सलाह देता हूं कि आप अपनी पीएचडीओसी टिप्पणियों के आधार पर कैसे हैं।

मुझे आशा है कि नेटबीन्स 7.1 डॉकब्लॉक्स समर्थन पेश करेगा क्योंकि यह बहुत बेहतर है। यह PHP 5.3 जागरूक है और इसे सक्रिय रूप से बनाए रखा गया है।

+1

धन्यवाद। मैं वहां से डॉक्टर जेनरेटर के असंख्य से अवगत हूं, लेकिन वे सभी PHPDoc बेस पर विस्तारित प्रतीत होते हैं, इसलिए मैं चुपचाप उम्मीद कर रहा था कि एक मानक होगा, लेकिन मुझे लगता है कि शायद नहीं। अब जेनरेटर की मेरी व्यक्तिगत पसंद है - http://apigen.org –

+1

यदि वे सभी phpDoc का विस्तार करना प्रतीत होता है ... अच्छा ... आपको कुछ बताना चाहिए। अर्थात्, दस्तावेज़ * टिप्पणियों के लिए * एक मुख्य मानक है। आप जिस प्रणाली का उपयोग करते हैं वह बदल सकता है, लेकिन टिप्पणियां काफी समान होंगी। – cHao

+1

मैंने phpdocumentor के कुछ डेवलपर्स को ईमेल किया, जिन्होंने मुझे बताया कि परियोजना 'मृत' नहीं है, लेकिन PHP 5.3 फीचर्स प्राप्त करने के लिए इसे बढ़ाने के लिए नहीं बढ़ेगा (विकिपीडिया लेख को तदनुसार अपडेट किया गया था, और अब इस परियोजना को बंद नहीं किया गया है) । मैं @ इवोसाबेव से सहमत हूं, एपीजन मेरा नया निजी पसंदीदा है। – William

1

अगस्त 2013 तक PHP Framework Interoperability Group ने PHPDoc के लिए एक औपचारिक विनिर्देश (पीएसआर) लिखना शुरू किया। PHPDoc के लिए प्रस्तावित मानक, वर्तमान ड्राफ्ट पीएसआर 5: https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md

वर्तमान ड्राफ्ट PHP 5.3+ को संबोधित करने के साथ-साथ अन्य परिवर्तनों के पते के विनिर्देश को अद्यतन करता है।मेरा मानना ​​है कि उम्मीद है कि php टिप्पणियों के लिए यह मानक एकाधिक दस्तावेज़ जेनरेटर में अपनाया जाएगा।