2008-09-24 16 views
11

मैं एक्शनस्क्रिप्ट फ़ाइलों को दस्तावेज़ित करने के लिए DoxyGen को कैसे कॉन्फ़िगर कर सकता हूं?क्या मैं एक्शनस्क्रिप्ट कोड दस्तावेज़ करने के लिए DoxyGen का उपयोग कर सकता हूं?

मैंने * .as और * .asi फ़ाइलों को डॉक्सिजन के खोज पैटर्न में शामिल किया है, लेकिन कक्षाएं, कार्य और चर वहां नहीं दिखते हैं।

उत्तर

12

डॉक्सिजन के बजाय आपको एक दस्तावेज जनरेटर का उपयोग करना चाहिए जो विशेष रूप से भाषा का समर्थन करता है।

  1. NaturalDocs (example) (नि: शुल्क)
  2. ZenDoc (नि: शुल्क)
  3. AS2Doc Pro (example) (वाणिज्यिक)

आप उपयोग कर रहे हैं: Actionscript 2 के लिए, आप एक जोड़े विकल्प हैं एक्शनस्क्रिप्ट 3, एडोब में उनके ओपन सोर्स कंपाइलर (Flex SDK) के साथ एक मुफ्त दस्तावेज जनरेटर शामिल है, जिसे "ASDoc" कहा जाता है। यदि आप FlashDevelop का उपयोग कर रहे हैं, तो latest beta एएसडीओसी चलाने के लिए जीयूआई में बनाया गया है, इसलिए आपको कमांडलाइन के साथ अपने हाथों को गंदे करने की ज़रूरत नहीं है।

3

मैं Doxygen के साथ कुछ दस्तावेज (मैं क्या कह सकता है - मैं अपनी सुविधाओं और क्षमताओं की तरह) का उत्पादन कर लिया है निम्न कार्य द्वारा: फ़ाइल की सूची में

जोड़ें * .as और * .asi इनपुट करने के लिए प्रकार।

चुनें:

OPTIMIZE_OUTPUT_JAVA = YES 
EXTRACT_ALL   = YES 
HIDE_UNDOC_MEMBERS  = NO 
HIDE_UNDOC_CLASSES  = NO 

एक और मुद्दा AS3 में पैकेज बयान है। आपको पैकेज परिभाषा को अनदेखा करने के लिए DoxyGen को बताना होगा। कंड का उपयोग करना आसान है।

package myPackage { 

में
/// @cond 
package myPackage { 
/// @endcond 

कौन सा Doxygen cond और endcond के बीच की रेखा (रों) की अनदेखी करने के कारण होगा: तो तुम लाइन बदल देंगे। ध्यान दें कि आपकी .as फ़ाइल के नीचे बंद घुंघराले ब्रैकेट के लिए ऐसा करने की आवश्यकता नहीं है।

+0

यह मेरे लिए काम नहीं करता है। डॉक्सिजन एएस 3 के व्याकरण को बिल्कुल नहीं पहचानता है। यह गलत तरीके से कार्य निकायों को "लोक सदस्य कार्य" के रूप में पार्स करता है। –

2

आप ऑरटेलियस का भी उपयोग कर सकते हैं। एएसडीओसी से उपयोग करना आसान है क्योंकि यह एक साधारण जीयूआई के साथ आता है, और यह आपके कोड के लिए अधिक माफ कर दिया गया है। इसका मुफ़्त और ओपनसोर्स, लेकिन केवल विंडोज़।

ortelius.marten.dk