2016-05-09 20 views
9

मुझे कोणीय 2 के साथ थोड़ा सा अनुभव है, लेकिन मैं अभी भी फ्रेमवर्क के लिए अपेक्षाकृत नया हूं। चारों ओर देखकर, मुझे कुछ ऐसा पता चला जिसे ngdocs कहा जाता है। यह बहुत अच्छा है क्योंकि यह आपके कोड में टिप्पणियों के आधार पर आपके लिए एक प्रकार का दस्तावेज/विकी क्षेत्र बनाता है। (जेएस डॉक्स के समान)। हालांकि, ऐसा लगता है कि यह कोणीय 1.XX के साथ विशेष रूप से उपयोग के लिए लिखा गया है।कोणीय 2 प्रलेखन/कोणीय 2 के लिए एक ngdocs है?

मैंने कुछ खोज किया है, लेकिन कुछ भी ऐसा नहीं लगता है जो कोणीय 2 के लिए समान कार्यक्षमता प्रदान करेगा। क्या किसी को पता है कि कोणीय 2 के लिए एनजी-डॉक्स के समान कुछ है या नहीं?

+0

कुछ चीजें ध्यान दें: - मैं टाइपस्क्रिप्ट के साथ कोणीय 2 का उपयोग कर रहा हूं। - मैंने कोणीय 2 के साथ ngdocs का उपयोग करने का प्रयास किया है। मैं वास्तव में इसका उपयोग नहीं कर सकता क्योंकि: 1. जेनरेट प्रलेखन कोणीय 1. का उपयोग कर रहा है 2. टाइपस्क्रिप्ट कंपाइलर अक्सर टिप्पणियों को स्ट्रिप करता है (उन्हें कुछ क्षेत्रों में होना चाहिए)। 3. @ngdoc टैग मुझे दस्तावेज़ों को व्यवस्थित करने की अनुमति नहीं देता है जो कोणीय 2 के लिए समझ में आता है। (यानी घटक टैग पर त्रुटियां बनाएं) इसके अलावा, मैं ggp के साथ ngdocs का उपयोग कर रहा हूं। –

उत्तर

4

एकमात्र चीज जो मैंने पाया है अब TypeDoc है। यह कोणीय के लिए विशिष्ट नहीं है लेकिन यह आपके लिए टाइपस्क्रिप्ट के आधार पर कुछ दस्तावेज तैयार करेगा। ऐसा कुछ चीजों को करने की क्षमता में कमी दिखाई देता है जिनका उपयोग आप ngDoc (लाइव उदाहरण और ऐसे) के साथ कर सकते हैं।

3

कंपोडोक (https://medium.com/vincent-ogloblinsky/compodoc-documentation-tool-for-angular-2-applications-44ec650e01a8) नामक एक प्रोजेक्ट भी है, जो कोणीय 2/4 के लिए विशिष्ट दस्तावेज उत्पन्न करता है।

वे सामान्य टिप्पणियों का उपयोग कर रहे हैं और मार्कडाउन सिंटैक्स का भी समर्थन जोड़ा है।

+1

यही वह है जो मैं अब भी उपयोग करता हूं। यह बहुत ठंडा है। – Jason

+0

एकमात्र चीज जो मुझे याद आती है वह डेमो बटन जोड़ने और उन्हें कस्टम घटकों से जोड़ने की संभावना है। –