यह एक बहुत ही अनिवार्य और अनिच्छुक प्रश्न है, मुझे डर है, लेकिन मैं हमेशा इसके बारे में सोचता हूं। जब आप इनलाइन टिप्पणियों के साथ कोड पर टिप्पणी कर रहे हैं (टिप्पणियों के विपरीत जो उत्पन्न दस्तावेज में दिखाई देंगे) और एक चर का नाम टिप्पणी में दिखाई देता है, तो आप इसे सामान्य पाठ से कैसे अलग करते हैं? उदा .:प्रलेखन शैली: आप किसी टिप्पणी के भीतर शेष पाठ से परिवर्तनीय नामों को कैसे अलग करते हैं?
// Try to parse type.
parsedType = tryParse(type);
टिप्पणी में, "प्रकार" चर का नाम है। क्या आप इसे किसी भी तरह से इंगित करने के लिए चिह्नित करते हैं कि यह प्रतीक है और न केवल टिप्पणी के पाठ का हिस्सा है? मैं इस तरह बातें देखा है:
// Try to parse "type".
// Try to parse 'type'.
// Try to parse *type*.
// Try to parse <type>.
// Try to parse [type].
और यह भी:
// Try to parse variable type.
(मुझे नहीं लगता कि पिछले एक बहुत उपयोगी है है, यह थोड़ा भ्रामक है, तुम सोच सकता है "चर" है वहां एक विशेषण)
क्या आपके पास कोई वरीयता है? मुझे लगता है कि मुझे किसी प्रकार का मार्कर इस्तेमाल करने की ज़रूरत है; अन्यथा टिप्पणियां कभी-कभी संदिग्ध होती हैं, या कम से कम आपको फिर से पढ़ने के लिए मजबूर करती हैं जब आप टिप्पणी में एक विशेष शब्द का एहसास करते हैं तो वास्तव में एक चर का नाम था।
(टिप्पणी है कि दस्तावेज में दिखाई देगी मैं निश्चित रूप से, जनरेटर के लिए उपयुक्त टैग का उपयोग में: @code, < कोड > </कोड >, आदि)
धन्यवाद!
धन्यवाद, मैं पुष्टि प्राप्त करना चाहता था :)। मुझे पता है कि कुछ लोग इन चीजों के बारे में बहुत खास हैं, और मैंने सोचा कि क्या किसी प्रकार का मानक था, या कम से कम कुछ भी नहीं;) – Alix