2011-09-07 13 views
44

मेरे टीमों सी-कोड के दिशा निर्देशों के बारे में है कि यह बेहतर एक '<' ने एक टिप्पणी में जगह नीचे दिखाया गया है की तरह होगी:सी टिप्पणी क्यों करें * * */आवश्यकता '<'?

#define MAX_PACK_ITEM_NUM 50 /**< max number of item */ 

मुझे आश्चर्य है, इस '<' का वास्तविक उपयोग क्या है?

+0

एआरएम, एक तीर के रूप में? यह एक टिप्पणी है, इसलिए यहां कोई भी नहीं है जो इसका उत्तर देने में सक्षम होगा। –

+46

आपकी टीम का उत्तर क्या है? – Henrik

+13

लोग इसे बंद करना क्यों चाहते हैं? यह एक बिल्कुल वैध सवाल है! –

उत्तर

73

यह फ़ाइल/संरचना/संघ/कक्षा/enum के सदस्यों के लिए दस्तावेज़ीकरण उत्पन्न करने के लिए doxygen का एक तरीका है। उस मार्कर का उपयोग करके, आप प्रत्येक सदस्य के बाद टिप्पणियां डाल सकते हैं, जिससे कम अव्यवस्था हो सकती है। आप here के बारे में अधिक पढ़ सकते हैं।

10

मुझे लगता है कि आपकी टीम कुछ स्वचालित दस्तावेज टूल का उपयोग करती है जो /**< की तलाश में है; जैसे Doxygen

+6

उदाहरण के लिए डॉक्सिजन सदस्यों के वर्णन के लिए इन कोण ब्रैकेट का उपयोग करता है। – arne

17

घोषणा/परिभाषा के बाद सदस्यों को टिप्पणी करने के लिए यह doxygen syntax है।

45

जैसा कि अन्य ने उत्तर दिया है, यह शायद एक टिप्पणी है जो डॉक्सिजन के लिए है। जब टिप्पणियों को पार्स, कुछ विशेष नियम है Doxygen:

  • एक साधारण टिप्पणी /* के साथ शुरू नजरअंदाज कर दिया Doxygen कर रहा है।
  • /** से शुरू होने वाली एक टिप्पणी को स्रोत कोड में टिप्पणी के बाद के अगले आइटम के दस्तावेज़ के रूप में माना जाता है।
  • /**< से शुरू होने वाली एक टिप्पणी को स्रोत कोड में टिप्पणी से पहले आइटम के दस्तावेज़ के रूप में माना जाता है।

दस्तावेज़ीकरण अधिकतर दस्तावेज वाले आइटम से ऊपर रखा गया है, उदा। एक समारोह। लेकिन कुछ मामलों में #define के बजाय दस्तावेज़ के बजाय लाइन के अंत में प्रलेखन रखना समझ में आता है और उस स्थिति में /**< मार्कर की आवश्यकता होती है।

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