2009-02-10 4 views
8

के लिए GhostDoc जैसे कुछ भी है जब मैं सी # में विकास कर रहा हूं, तो मैं अपने कोड पर टिप्पणी करने की प्रक्रिया को तेज करने के लिए GhostDoc का भारी उपयोग करता हूं। मैं वर्तमान में एक सी ++ परियोजना पर काम कर रहा हूं और मुझे समकक्ष उपकरण नहीं मिला है। मुझे डॉक्सिजन के बारे में पता है, लेकिन मुझे पता है कि कोड के बाहर दस्तावेज़ बनाने के लिए कोड का उपयोग करने के लिए इसका उपयोग किया जाता है। क्या कोई अच्छा समकक्ष उपकरण हैं? मैं वीएस में चलने वाला एक पसंद करूंगा, लेकिन मैं किसी भी आईडीई में काम करने वाले को संभाल सकता हूं।क्या सी ++

(इससे पहले कि कोई यह लाता है, मैं पूरी तरह से GhostDoc पर टिप्पणियों बनाने के लिए भरोसा नहीं है। मैं सिर्फ अपनी टिप्पणी के लिए प्रारंभिक बिंदु बनाने के लिए इसका इस्तेमाल करते हैं।)

+2

सिर्फ रिकॉर्ड के लिए - GhostDoc v4 अब सी/सी ++ के लिए एक्सएमएल टिप्पणी पीढ़ी का भी समर्थन करता है। – sergeb

उत्तर

3

Visual Assist टाइपिंग (या अन्य पर) के दौरान निष्पादित कस्टम स्क्रिप्ट प्रदान करके सहायता करता है।

/************************************************************************/ 
/* My comment : $end$                  */ 
/************************************************************************/ 

सुझाव होगा कि (एक कॉम्बो बॉक्स बिल्कुल IntelliSense की तरह के माध्यम से) जब आप लिखना शुरू "/ **" उदाहरण के लिए:

उदाहरण के लिए, अगर आप इस तरह की टिप्पणियों के लिए एक स्क्रिप्ट हो सकता है। जब आप इस सुझाव का चयन करते हैं (एंटर/स्पेस/क्लिक - कस्टमाइज़ेबल के माध्यम से), यह स्क्रिप्ट डालेगा जहां आपका कर्सर है और केवल विशेष मानों से '$' वर्णों के बीच मार्करों को प्रतिस्थापित करें (उदाहरण के लिए वर्तमान फ़ाइल नाम)। यहां $ end $ मार्कर स्क्रिप्ट निष्पादित होने पर कर्सर को इस स्थिति में बनाएगा। इस तरह, आप आसानी से टाइपिंग जारी रखते हैं। पिछले स्क्रिप्ट सेट के साथ उदाहरण के लिए, वास्तव में टाइपिंग:

/** this is a test comment to show you one of the many features Visual Assit! 

बस दे देंगे:

/************************************************************************/ 
/* My comment : this is a test comment to show you one of the many features Visual Assit!                  */ 
/************************************************************************/ 

यह अनुकूलित करने के लिए वास्तव में आसान है और सुझाव के व्यवहार (पढ़ें: IntelliSense ++) प्रणाली अनुकूलन योग्य है।

0

Visual Assist काम कर सकता है, हालांकि मैं मैं पूरी तरह से यकीन नहीं है।

6

मैं एक ऐड-इन में लिखा है, Atomineer Pro Documentation, जो बहुत GhostDoc के समान है (यह उत्पन्न करता है/अद्यतन प्रलेखन टिप्पणियों समय और प्रयास की एक बहुत बचाने के लिए जब दस्तावेजीकरण), लेकिन यह खुद के लिए सीधे कोड को पार्स करता है और इस प्रकार सी, सी ++, सी ++/सीएलआई, सी #, जावा और विजुअल बेसिक कोड को संभालने में सक्षम है, और इसे काम करने से पहले आसपास के कोड को एक संकलित स्थिति में होने की आवश्यकता नहीं है। यह स्वचालित रूप से एक विधि के शरीर के भीतर फेंकने वाले अपवाद जैसे अधिक कठिन चीजों के लिए दस्तावेज़ों को स्वचालित रूप से जोड़/अपडेट करेगा।

यह विजुअल स्टूडियो 11, 2010, 2008 और 2005 के तहत चलता है, और दस्तावेज़ीकरण-एक्सएमएल, डॉक्सीजन, जावाडोक और क्यूटी टिप्पणी प्रारूपों के साथ-साथ टिप्पणी ब्लॉक के स्वरूप/शैली का समर्थन करता है और ऑटो-डॉक नियम अत्यधिक उपयोग किए जाते हैं विन्यास। इसमें कई अन्य आसान विशेषताएं हैं जैसे उपरोक्त प्रारूपों में विरासत दस्तावेज़-टिप्पणियों के रूपांतरण की सहायता करना, और दस्तावेज़-टिप्पणियों और सामान्य ब्लॉक टिप्पणियों में शब्द लपेटना।

उपरोक्त कुछ प्रमुख विशेषताओं का सारांश है - यह comparison of features अन्य उत्पादों के साथ उपलब्ध कई अन्य सुविधाओं की एक पूरी सूची के रूप में कार्य करता है।