8
मैं अपने उद्देश्य सी कोड के लिए दस्तावेज़ उत्पन्न करने के लिए डॉक्सीजन का उपयोग करता हूं। अभी तक, मैं गुणों को सही ढंग से दस्तावेज करने के तरीके के लिए कोई दिशानिर्देश नहीं ढूंढ पा रहा हूं। उदाहरण मैंने देखा है कि यह हर कल्पनीय तरीके से करते हैं। कुछ लोग स्वयं चर को दस्तावेज करते हैं, कुछ लोग @property घोषणाओं को दस्तावेज करते हैं। कुछ // // का उपयोग करते हैं, जबकि अन्य पूर्ण/** */ब्लॉक का उपयोग करते हैं।उद्देश्य सी @property टिप्पणियां
क्या कोई मुझे सर्वोत्तम प्रथाओं के संदर्भ में इंगित कर सकता है? या शायद Doxygen के साथ भविष्य की संगतता के बारे में कुछ जानकारी? मैं एक पैटर्न से चिपकना चाहता हूं कि कम से कम, आधिकारिक पैटर्न विकसित करने के बाद, डॉक्सीजन को अनुकूलित करना आसान होगा।
उपयोगी संदर्भ, और मैंने इसे वोट दिया, लेकिन वास्तव में मेरे किसी भी प्रश्न का उत्तर नहीं देता है। Google डॉक @property टिप्पणी के लिए किसी भी दिशानिर्देश को छोड़ देता है, और हेडरडॉक निश्चित रूप से एक विकल्प है लेकिन मेरे लिए समाधान नहीं है। – DougW