इंटेलिसेंस में दिखाई देने वाली सी ++ टिप्पणियां कैसे लिखें?

Question

मैं विजुअल स्टूडियो 2010 अल्टीमेट का उपयोग कर सी ++ में प्रोग्रामिंग कर रहा हूं। मैं कुछ कार्यों को दस्तावेज करना चाहता हूं और मैं इंटेलिजेंस में दस्तावेज दिखाना चाहता हूं।

MSDN के अनुसार, मुझे घोषणा से पहले या उसी पंक्ति पर टिप्पणी करने की आवश्यकता है।

// This is a test. 
void foo(); 
void bar() { foo(); } 

जब foo() पर मेरे माउस को ले जाकर, टिप्पणी टूलटिप में प्रकट नहीं होता: तो मैं इस कोशिश की। मैं भी करने की कोशिश की:

• ///
• <summary></summary> टैग
• बिल्डिंग /doc साथ

मुझे कोई भाग्यशाली रहे हैं (स्थापित करने परियोजना सेटिंग्स में विकल्प "एक्सएमएल दस्तावेज़ फ़ाइलों उत्पन्न करें" से) अब तक। क्या कोई इस काम को करने का तरीका जानता है?

Answer 1

Visual Assist स्थापित करने और doxigen शैली का उपयोग का प्रयास करें:

/** 
* COMENT OF A CLASS 
**/ 
class Foo 
{ 
    public: 
     /** 
     * \brief A foo method. 
     * 
     * More complete description of foo. 
     * 
     * \param i A foo parameter. 
     * \return An int 
     * 
     **/ 
     int fooMethod(int i); 

    private: 
     int i; /*!< COMENT OF A MEMBER */ 

}; 

Answer 2

यह अब वी.एस. 2012 में समर्थित!

पहले, टिप्पणियों में एक्सएमएल टैग केवल सी ++/सीएलआई द्वारा पढ़े गए थे, सादे पुराने सी ++ नहीं। वीएस 2012 अब कम से कम कुछ सी ++ में लाता है - यह What's New in Visual Studio 2012 में और एमएसडीएन दस्तावेज़ों में है: XML Documentation (Visual C++)।

मैंने 2012 के अंतिम पर अपने स्वयं के आवेदन के साथ इसका परीक्षण किया है, और मैं पुष्टि कर सकता हूं कि सारांश, पैरा, और देखने के टैग सभी टूलटिप्स के लिए स्वरूपित किए गए हैं।

Answer 3

मैंने वीएस -2010 का उपयोग नहीं किया है यह याद रखने के लिए बहुत सालों है कि यह वहां काम करता है या नहीं। मैन्युअल रूप से में डाल वास्तव में क्या दृश्य स्टूडियो पूर्ण रूप से अपने आप के लिए सी # कोड के लिए में डाल देंगे

#pragma region foo(float) 
/// <summary> .... </summary> 
/// <param name="bar"> .... </param> 
/// <returns> .... </returns> 
int foo(float bar) 
{ 
    // stuff 
} 
#pragma endregion 

दूसरे शब्दों में: लेकिन क्या मैं वी.एस. के कई अलग अलग संस्करण में साल के लिए किया है ... है।

फिर फ़ाइल को दोबारा लगाने के लिए इंटेलिसेंस इंजन को एक मिनट या उससे अधिक दें। एक निर्माण करने से, निश्चित रूप से इसे पुनर्भुगतान करने के लिए मजबूर किया जाएगा।

जैसा कि मुझे याद है, यह हाल ही में वीएस -2010 एक्सप्रेस समुदाय में काम करता है, लेकिन मुझे याद नहीं है कि यह वीएस -2010 अल्टीमेट में काम करता है या नहीं।

Answer 4

मुझे यकीन है कि दृश्य स्टूडियो का संस्करण पेश किया लेकिन वी.एस. 2015 में आप बस एक function, method, class, struct, union, enum class, namespace या यहां तक ​​कि अलग-अलग चर ऊपर टिप्पणी डाल सकते हैं जो नहीं कर रहा हूँ (स्थानीय लोगों को भी) और यह Intellisense द्वारा दिखाया जाएगा। यदि आप किसी भिन्न मॉड्यूल से कुछ दस्तावेज करना चाहते हैं, तो आपको हेडर फ़ाइल में एक टिप्पणी लिखनी होगी। उदाहरण: