सी ++

Question

में डॉक्टर स्ट्रिंग सुविधा पाइथन, MATLAB, E-Lisp जैसी भाषाएं डॉक्टर-स्ट्रिंग्स के लिए यह अच्छी सुविधा है। टर्मिनल में केवल कुछ कीस्ट्रोक का उपयोग करके इस सुविधा के साथ, आप अपने कोड में लिखे गए कार्यों और मॉड्यूल के दस्तावेज़ों को प्राप्त कर सकते हैं।

अब वहाँ किसी भी "तकनीक" (पुस्तकालय, संपादक चाल, जो कुछ भी करने के लिए) सी ++/सी में एक ऐसी ही सुविधा प्राप्त करने के लिए मान लीजिए कि मैं पर समारोह के प्रमुख स्रोत फ़ाइल के भीतर समारोह के दस्तावेज शामिल है , तो मैं टर्मिनल पर getinfo जैसे कमांड टाइप करना चाहता हूं। ( एक मैन पेज की तरह)

मुझे पता है कि इस तरह की 'मैन' सुविधा कई सी कार्यों के लिए मौजूद है, लेकिन इन कार्यों के लिए दस्तावेज़ स्रोत कोड से अलग टेक्स्ट फ़ाइलों में लिखे गए हैं। मुझे दस्तावेज

Answer 1

आप Doxygen जैसे कुछ का उपयोग कर सकते हैं। इसमें अन्य प्रारूपों के साथ man pages उत्पन्न करने के लिए समर्थन है।

Answer 2

यदि आप जावाडोक के समान वाक्यविन्यास में टिप्पणियों के साथ अपना कोड नोट करते हैं, तो आप Doxygen का उपयोग करके विभिन्न कोडों में अपने कोड के लिए एक दस्तावेज़ तैयार कर सकते हैं। यह अन्य चीजों के साथ, मैन पेजों को उत्पन्न कर सकता है, लेकिन ऐसा लगता है कि लोगों द्वारा उपयोग किए जाने वाले पसंदीदा आउटपुट प्रारूप HTML पृष्ठ हैं।

Answer 3

विजुअल स्टूडियो DocXml स्वरूपित टिप्पणियों से निकाली गई जानकारी वाले पॉपअप उत्पन्न/उत्पन्न करेगा। आपको /doc के साथ संकलित करना होगा, जो टिप्पणियों से एक्सएमएल को .xdc फ़ाइल में निकाल देगा। .xdc फ़ाइलों को एक XML फ़ाइल में संकलित करने के लिए आपको xdcmake चलाएं। आप आमतौर पर निर्माण प्रक्रिया में यह सब स्वचालित रूप से संभाल लेंगे, इसलिए आपको मैन्युअल रूप से बहुत कुछ करने की ज़रूरत नहीं है (बेशक टिप्पणियां स्वयं को छोड़कर)। ध्यान में रखना एक बात यह है कि पॉपअप प्राप्त करने से पहले कोड (कम से कम एक घोषणा) बनाना है।

मुझे लगता है कि आईएमओ जोड़ने के लिए बाध्य होना चाहिए, ऐसी अधिकांश टिप्पणियां आमतौर पर बेकार के करीब होती हैं। यदि कोई कॉर्पोरेट मानक उन्हें अपरिहार्य बनाता है, तो हो - लेकिन यदि वे ईमानदारी से कोई उपयोगी जानकारी प्रदान कर रहे हैं, तो मैं मानता हूं कि किसी समस्या का संकेत ("कोड गंध", यदि आप उस शब्द को पसंद करते हैं)। ज्यादातर मामलों में, फ़ंक्शन (या जो कुछ भी) के नाम और पैरामीटर के नाम/प्रकार का संयोजन फ़ंक्शन का उपयोग स्पष्ट रूप से स्पष्ट करना चाहिए।