उच्च-स्तरीय वर्ग प्रलेखन

Question

Rubycop जैसे संदेश आउटपुट। यह सिर्फ एक टिप्पणी नहीं है, है ना? इसे एक विशेष प्रारूप होना चाहिए, लेकिन कौन सा?

Answer 1

the Rubocop documentation से:

RuboCop एक रूबी स्थिर कोड विश्लेषक है। बॉक्स में से यह समुदाय Ruby Style Guide में उल्लिखित कई दिशानिर्देशों को लागू करेगा।

रूबी स्टाइल गाइड "टिप्पणी" खंड "गुम शीर्ष स्तर के वर्ग प्रलेखन टिप्पणी" लेकिन टिप्पणी पर गाइड अनुभाग पढ़ने से, आप जल्दी से उदाहरण है कि वर्गों और मॉड्यूल टिप्पणी करने से अनुमान लगा सकते हैं वाक्यांश का उपयोग नहीं करता इसकी सिफारिश की जाती है।

कारण है, rdoc का उपयोग करते समय, कक्षाओं/मॉड्यूल के लिए टिप्पणियों का उपयोग कोड के संदर्भ को उत्पन्न करने के लिए किया जाएगा, जो महत्वपूर्ण है कि आप स्वयं के लिए कोड लिख रहे हैं, एक टीम के लिए या सामान्य रिलीज के लिए दूसरों के द्वारा।

Answer 2

कहा कि एक साधारण टिप्पणी की तरह इतनी अच्छी तरह से करना होगा:

# This shiny device polishes bared foos 
class FooBarPolisher 
     ... 

HTH