दस्तावेजीकरण चर

Question

कोड:

#include <stdio.h> 

/* 
* \var int iOne 
* \brief Integer 1 
*/ 
/* 
* \var int iTwo 
* \brief Integer 2 
*/ 
/* 
* \var int iThree 
* \brief Integer 3 
*/ 

/** 
* \brief Imitates a sheep. 
*/ 
void sheep(); 

/** 
* \brief Main function for test code 
*/ 
int main() { 
    int iOne, iTwo, iThree; 
    iOne = 1; 
    iTwo = 2; 
    iThree = 3; 
    printf("%d %d %d", iOne, iTwo, iThree); 

    return 0; 
} 

void sheep() { 
    printf("Meeeh"); 
} 

यह iOne, iTwo और iThree हालांकि कि मेरा इरादा था के लिए विवरण उत्पन्न नहीं करता है। मैं यह कैसे तय करुं?

Answer 1

आपको /** के साथ डॉक्सिजन टिप्पणियों के रूप में अपनी टिप्पणियां खोलने की आवश्यकता है।

यह इस है, हालांकि ऐसा करने के लिए स्पष्ट हो सकता है: इस तरह आप अपने दस्तावेज़ को तोड़ने के बिना चर का नाम बदल सकते हैं

int main() { 
    /** \brief Integer 1 */ 
    int iOne; 
    /** \brief Integer 2 */ 
    int iTwo; 
    /** \brief Integer 3 */ 
    int iThree; 
    /** ... and so on ... */ 
} 

और यह भी अन्य प्रोग्रामर जो क्योंकि अपने स्रोत कोड पढ़ने की जरूरत है पर आसान है चर के विवरण इसके बगल में स्थित है, फ़ाइल में कहीं और नहीं।

Answer 2

डॉक्सिजन कक्षाओं और फ़ंक्शन हेडर दस्तावेज़ों या अन्य शब्दों में, इंटरफ़ेस दस्तावेज करने के लिए बनाया गया था। प्रलेखन के बारे में सोचें जो अन्य प्रोग्रामर आपके वर्गों और कार्यों का सही ढंग से उपयोग करने के लिए अध्ययन करते हैं। आपको अपने कार्यान्वयन को दस्तावेज करने के लिए DOxygen का उपयोग नहीं करना चाहिए। इसके बजाय, स्रोत में अपने स्थानीय चर // या /* */ के साथ दस्तावेज़ करें।

DOxygen में टिप्पणियां करने के कई तरीके हैं, जिनमें से कुछ उदाहरण (सदस्य चर के लिए) मैनुअल here में देखे जा सकते हैं। मैंने उन्हें नीचे कॉपी किया है।

int var; /*!< Detailed description after the member */ 

int var; /**< Detailed description after the member */ 

int var; //!< Detailed description after the member 
     //!< 

int var; ///< Detailed description after the member 
     ///< 

int var; //!< Brief description after the member 

int var; ///< Brief description after the member