मुझे सी में टिप्पणियां कैसे लिखनी नहीं मिल सकतीं। मेरा मतलब है कि मुझे // और /* */ के बारे में पता है, मेरा मतलब यह है कि मुझे अच्छे अभ्यास कहां मिल सकते हैं? जैसे कि मेरे पास कोई फ़ंक्शन है, तो मैं @param variable is the value bla bla कैसे लिखूं, जैसे जावा में किया जाता है?एएनएसआई सी में प्रलेखन टिप्पणियां कैसे लिखें?
क्या इसके लिए कोई मानदंड है? या मैं बस ऐसा कर सकता हूं जैसे मैं जावा में करता हूं?
कई अलग अलग मानक हैं, यदि आप प्रलेखन उत्पन्न करना चाहते हैं, doxygen
कोशिश कोई मानकों मानक है जो आपकी कंपनी जनादेश का पालन कर रहे हैं।
परियोजनाओं से दस्तावेज बनाने का एक लोकप्रिय तरीका Doxygen का उपयोग करना है।
एक विकल्प लेखन टिप्पणियों के डॉक्सिजन प्रारूप का उपयोग करना है - इसमें आपके कोड के लिए एचटीएमएल/लेटेक्स और अन्य प्रकार के दस्तावेज़ उत्पन्न करने में सक्षम होने का अतिरिक्त लाभ है।
आप जावाडोक मानक का उपयोग कर सकते हैं और फिर doxygen का उपयोग कर सकते हैं जो दस्तावेज उत्पन्न करने के लिए जावाडोक को समझता है।
डॉक्सिजन में मैं JAVADOC_AUTOBRIEF विकल्प YES पर सेट करने का सुझाव देता हूं। यदि JAVADOC_AUTOBRIEF टैग को YES पर सेट किया गया है तो डॉक्सिजन संक्षिप्त विवरण के रूप में जावाडोक-शैली टिप्पणी की पहली पंक्ति (पहले बिंदु तक) की व्याख्या करेगा। एक वर्ग परिभाषा के लिए
उदाहरण:
/**
* A brief description. A more elaborate class description
* @param bool somebool a boolean argument.
* @see Test()
* @return The test results
*/
(कुछ और उदाहरण in the doxygen manual)
स्थापना वास्तव में आसान है, एक जीयूआई और एक अच्छा चित्रमय दृश्य के साथ उपलब्ध है:
apt-get install doxygen doxygen-gui graphviz
गुई कॉलिंग doxywizard चलाएं और विज़ार्ड सेटिंग्स का उपयोग करें, केवल JAVADOC_AUTOBRIEF को "विशेषज्ञ" बस में सेट करना होगा बैठकों।
एक उदाहरण के साथ एक अच्छा जवाब। – Drew
असल में, आप एएनएसआई सी में '//' का भी उपयोग नहीं कर सकते हैं केवल सी 99 से ही उन्होंने '//' की अनुमति दी है। (हालांकि जीसीसी इसे विस्तार के रूप में अनुमति देता है।) – Mysticial
सी/// * में केवल '/ * * /' समर्थित है सी ++ –
में एक जोड़ा है "एएनएसआई सी" शब्द आमतौर पर 1 9 8 9 एएनएसआई मानक द्वारा वर्णित भाषा को संदर्भित करता है , लेकिन कड़ाई से बोलना गलत है। 1 99 0 में, आईएसओ ने एक ही मानक जारी किया (कुछ नई प्रारंभिक सामग्री और पुनर्निर्मित वर्गों के साथ), और एएनएसआई ने इसे अपनाया। 1 999 में, आईएसओ ने एक नया सी मानक जारी किया, और एएनएसआई ने इसे भी अपनाया, 1 9 8 9/1 9 0 9 मानक आधिकारिक रूप से अप्रचलित। 2011 के अंत में, आईएसओ ने एक और नया सी मानक जारी किया, जिसे एएनएसआई ने भी अपनाया है। पहले के अलावा, सी मानकों को प्रारंभ में आईएसओ द्वारा प्रकाशित किया गया है, एएनएसआई नहीं - और साल के मानकों को संदर्भित करना सबसे अच्छा है। –