सुंदर सी ++ टिप्पणियों को लिखने के उदाहरण

Question

शायद बेवकूफ सवाल है लेकिन क्या सी ++ फ़ंक्शन, हेडर, वेरिएबल के लिए टिप्पणियां लिखने के लिए अच्छे दिखने वाले (लघु) प्रारूप लिखने का कोई तरीका है? कोई दृश्य उदाहरण?

Answer 1

आप अच्छा से क्या मतलब देख करते चर के लिए

/** 
* Method description. 
* @param param1 param1 description 
* @param param2 param2 description 
* @return return description 
* @since date since method is created 
* @author who have made this method. 
*/ 

: विधि के लिए

यहाँ ? मैं इस तरह यह करना ..

int c;//! loop Counter 

/** 
* compares (XOR) two Types 
* return boolean result 
*/ 
bool compare(Type l, Type r); 

इसके Doxygen प्रारूप। टिप्पणी में कोड दस्तावेज करने के लिए पॉपुलर प्रारूप हैं। डॉक्सिजन एक है और दूसरा प्राकृतिक डॉक्स है। और भी कुछ हैं। यह तुम्हारा स्वाद है। आप प्राकृतिक डॉक्स प्रारूप भी पसंद कर सकते हैं।

/* 
    Function: Compare 
    Compares two Types 
    Parameters: 
     l - lhs 
     r - rhs. 
    Returns: 
     boolean result 

*/ 
bool compare(Type l, Type r); 

डीओसी ++ प्रारूप भी सिमिलर जैसा है।

/** Comparison 
    Compare two Types 

    @param l Type lhs 
    @param r Type rhs 
    @return boolean result 
*/ 
bool compare(Type l, Type r); 

बस केवल एक प्रारूप का उपयोग करें और इसके साथ चिपके रहें।

Answer 2

मैं इस शैली का प्रयोग पसंद करते हैं:

/** 
* Class name 
* Description 
*/ 

class MyClass{ 

} 

Answer 3

सबसे अच्छा तरीका है इस तरह से कि कुछ स्वचालित उपकरण उन्हें निकालने और तिर्यक प्रलेखन बना सकते हैं यह करने के लिए है। Doxygen

Answer 4

पर एक नज़र डालें http://www.stack.nl/~dimitri/doxygen/ पर एक नज़र डालें। असल में, जावाडोक प्रारूप पर एक टेक-ऑफ, जहां एक सहायता फ़ाइल के लिए, एक निश्चित डिग्री के लिए प्रारूप का अर्थ है।

मैं स्वयं-दस्तावेज़ कोड में आस्तिक हूं, लेकिन कुछ अच्छी तरह से ज्ञात टिप्पणियां बहुत मदद कर सकती हैं।

Answer 5

मैं निम्नलिखित शैली का उपयोग करें:

/** variables description **/ 

वर्ग के लिए

:

/** 
* Class description. 
* @since date since class is created 
* @author who have made this class. 
*/ 

Answer 6

कुछ सुझाव देंगे कि सबसे सुंदर टिप्पणियां वे हैं जो पूरे कार्यक्रम में सुसंगत हैं। मैं स्लैश आगे का उपयोग करना पसंद:

// -- short concise comments in single lines like this 

// ----------------------------------------- 
// 
// Sectional Dividers Like This 
// 
// ----------------------------------------- 

जिसके अनुसार, इन यदि आप अपनी टिप्पणी से प्रलेखन उत्पन्न करने के लिए उम्मीद कर रहे हैं मदद नहीं करेगा।