2009-07-26 8 views
10

मैं ग्रहण + पीडीटी के साथ विकास कर रहा हूं। मैं अपने कोड, में phpdoc टिप्पणियां जोड़ रहा हूं लेकिन वास्तव में कभी ग्रहण में परिणामस्वरूप प्रलेखन उत्पन्न नहीं किया। मुझे यह कैसे करना चाहिए - क्या एक्लिप्स में कुछ कार्यक्षमता है, या डॉक्टर पीढ़ी को बाहरी रूप से किया जाना चाहिए?ग्रहण में या बाहर PHPDoc दस्तावेज़ जनरेटर?

उत्तर

5

प्रलेखन जेनरेट करने के लिए, आपको phpDocumentor का उपयोग करना चाहिए, जिसे एक पीईएआर पैकेज के रूप में स्थापित किया जा सकता है।

फिर, आपको इसे कमांड लाइन से कॉल करना होगा; मैंने कभी ग्रहण पीडीटी से इसे कभी नहीं देखा है।

एक अच्छा समाधान एक निरंतर एकीकरण मंच (उदाहरण के लिए phpUnderControl का उपयोग करके) है, और अपनी बिल्ड कॉन्फ़िगरेशन फ़ाइल में phpdoc के निर्माण के लिए एकीकृत है; इस तरह, प्रत्येक बार कोई व्यक्ति (या दिन में एक बार, या जब भी आप चाहते हैं ^^) करता है तो phpdoc उत्पन्न होता है।

ग्रहण पीडीटी में, आप "बाहरी उपकरण" को कॉल कर सकते हैं (मेनू में "रन> बाहरी उपकरण" देखें); यह आपको phpdoc कमांड लॉन्च करने की अनुमति देगा (जैसे आप सीएलआई से करते हैं); लेकिन यह निश्चित रूप से उपयोगकर्ता के अनुकूल नहीं है जैसा कि ज़ेंड स्टूडियो प्रदान करता है - वही कीमत नहीं, हालांकि ^^

+0

मैंने अपनी PHP परियोजनाओं को बनाने के लिए चींटी का उपयोग किया है, और आमतौर पर एक डॉक्टर लक्ष्य होता है। ग्रहण चींटी के साथ बहुत अच्छा खेलता है। इसके अलावा आप ग्रहण से फिंग चलाते हैं। –

1

हां ज़ेंड में ऐसा करने के लिए एक जादूगर है। यह brief guide देखें।

वैकल्पिक रूप से आप मानक phpDocumentor को आमंत्रित करने के लिए बाहरी लॉन्च कॉन्फ़िगरेशन बना सकते हैं।

  1. करें Run-> बाहरी उपकरण> बाहरी उपकरण विन्यास ...
  2. बाएं हाथ फलक में, का चयन कार्यक्रम फिर नए आइकन (बाएं सबसे फलक के ऊपर आइकन)।
  3. दाहिने हाथ फलक में, मुख्य टैब का चयन करें।
  4. नाम: फ़ील्ड में gener_doc दर्ज करें।
  5. स्थान: फ़ील्ड में phpdoc cli टूल का पथ दर्ज करें।
  6. तर्क फ़ील्ड में कोई आवश्यक तर्क दर्ज करें, उदा। वर्तमान परियोजना इनपुट $ {project_loc} के लिए।
  7. बाहरी कॉन्फ़िगरेशन चलाने के लिए, चलाएं चुनें।

विन्यास को फिर से चलाएं करने के लिए आप कुछ विकल्प हैं:

  1. उसके बाद generate_doc
  2. करें Run-> बाहरी उपकरण> generate_doc मेनू पट्टी external tools icon http://help.eclipse.org/ganymede/topic/org.eclipse.cdt.doc.user/images/icon%5Fext%5Ftools.png" से बाहरी उपकरण आइकन का चयन करें
  3. Alt + R, E, 1 दबाएं (लगता है कि gener_doc सूची में पहला आइटम है, अन्यथा उचित संख्या चुनें)
+0

धन्यवाद, लेकिन मैं नियमित ग्रहण + पीडीटी का उपयोग कर रहा हूं, जाहिर है कि ऐसा कोई विकल्प नहीं है। – AlexA

2

दस्तावेज उत्पन्न करने के लिए एक और शानदार टूल ApiGen है। इसे पियर के साथ इंस्टॉलेशन की आवश्यकता नहीं है (लेकिन इसमें शामिल है) और इसे एक स्टैंडअलोन पैकेज की तरह इस्तेमाल किया जा सकता है।

+0

हम विंडोज़ के लिए 'एपीजन' कैसे स्थापित करते हैं?मैंने 'फार' पैकेज डाउनलोड किया लेकिन आगे बढ़ने के बारे में कोई संकेत नहीं है। –

+0

@ सुहैलगुप्ता यहां एक नज़र डालें: https://github.com/ApiGen/ApiGen –

+0

इसलिए मैंने 'C: \ wamp \ www \ apigen.phar' पथ को उपयोगकर्ता चर' पथ 'और' सिस्टम 'के अंदर भी शामिल किया पथ। लेकिन यह काम नहीं करता है! बस कुछ भी प्रिंट नहीं करता है। –

संबंधित मुद्दे