यार्डोक - क्लाउड में ऑनलाइन

कार्यक्रम:

नाम

यार्डोक - रूबी प्रोग्रामिंग भाषा के लिए दस्तावेज़ तैयार करने के लिए रूबी टूल

SYNOPSIS

yarddoc [विकल्पों] [स्रोत फ़ाइलें [- अतिरिक्त_फ़ाइलें]] यार्ड डॉक्टर [विकल्पों] [स्रोत फ़ाइलें [-
अतिरिक्त_फ़ाइलें]]

वर्णन

यार्ड(1) रूबी प्रोग्रामिंग भाषा के लिए एक एक्स्टेंसिबल डॉक्यूमेंटेशन जेनरेशन टूल है।
यह उपयोगकर्ता को सुसंगत, उपयोगी दस्तावेज़ तैयार करने में सक्षम बनाता है जिसे निर्यात किया जा सकता है
बहुत आसानी से प्रारूपों की संख्या, और कस्टम रूबी निर्माणों के लिए विस्तार का भी समर्थन करता है
कस्टम वर्ग स्तर परिभाषाओं के रूप में।

यार्डोक, का पर्यायवाची यार्ड डॉक्टर की सूची से दस्तावेज़ तैयार करता है स्रोत फ़ाइलें. अगर
यह सूची हटा दी गई है, "{lib,app}/**/*.rb ext/**/*.c" का उपयोग किया गया है।

विकल्पों का एक आधार सेट जोड़कर निर्दिष्ट किया जा सकता है .यार्डऑप्ट्स अपने आधार पथ पर फ़ाइल करें
जिसमें रिक्त स्थान द्वारा अलग किए गए सभी अतिरिक्त विकल्प शामिल हैं।

विकल्प

सामान्य जानकारी ऑप्शंस
-b, --डीबी फ़ाइल
लोड करने या सहेजने के लिए निर्दिष्ट .yardoc db का उपयोग करें (डिफ़ॉल्ट रूप से .yardoc)

--[नहीं-]सिंगल-डीबी
क्या कोड ऑब्जेक्ट को एकल डेटाबेस फ़ाइल में संग्रहीत किया जाना चाहिए (उन्नत)

-n, --उत्पादन नही
केवल .yardoc डेटाबेस जेनरेट करें, कोई दस्तावेज़ीकरण नहीं।

-c, --उपयोग-कैश [फ़ाइल]
दस्तावेज़ तैयार करने के लिए कैश्ड .yardoc db का उपयोग करें (डिफ़ॉल्ट रूप से कोई कैश नहीं)

--नो-कैश
स्रोत को पार्स करने से पहले .yardoc db साफ़ करें।

--[नहीं-]yardopts [फ़ाइल]
यदि तर्क फ़ाइल से पढ़े जाने चाहिए (डिफ़ॉल्ट रूप से हाँ, फ़ाइल डिफ़ॉल्ट रूप से .yardopts पर)

--[नहीं-]दस्तावेज़
यदि तर्कों को .document फ़ाइल से पढ़ा जाना चाहिए (डिफ़ॉल्ट रूप से हाँ)

--नहीं-बचाओ
पार्स किए गए डेटा को यार्डोक डीबी में सेव न करें

--निकालना regexp
यदि फ़ाइल पथ मिलान से मेल खाती है तो उसे अनदेखा कर देता है (regexp)

उत्पादन विकल्पों
--एक फ़ाइल
एकल फ़ाइल के रूप में आउटपुट उत्पन्न करता है

--सूची
वस्तुओं को मानक रूप से सूचीबद्ध करें (इसका तात्पर्य है -n)

--कोई-सार्वजनिक नहीं
सार्वजनिक तरीके न दिखाएं. (डिफ़ॉल्ट सार्वजनिक दिखाता है)

--संरक्षित
संरक्षित तरीके दिखाएँ. (डिफ़ॉल्ट छुपाएँ सुरक्षित)

--निजी
निजी तरीके दिखाएँ. (डिफ़ॉल्ट निजी छुपाता है)

--नहीं-निजी
@निजी टैग के साथ वस्तुओं को छुपाएं

--[नहीं-]एपीआई API
किसी दिए गए एपीआई के लिए दस्तावेज़ तैयार करता है (ऑब्जेक्ट जो सही @api टैग को परिभाषित करते हैं)।
If --नहीं-आपी दिया गया है, बिना @api टैग वाले ऑब्जेक्ट प्रदर्शित करता है।

--एम्बेड-मिक्सिन्स
क्लास दस्तावेज़ीकरण में मिक्सिन विधियों को एम्बेड करता है

--एम्बेड-मिक्सिन [मापांक]
किसी विशेष मॉड्यूल से क्लास दस्तावेज़ीकरण में मिश्रण विधियों को एम्बेड करता है

--नो-हाइलाइट
आउटपुट में कोड ब्लॉक को हाइलाइट न करें।

--डिफ़ॉल्ट-वापसी TYPE
यदि विधि में कोई रिटर्न प्रकार नहीं है तो दिखाया गया है। (डिफ़ॉल्ट 'ऑब्जेक्ट' पर)

--छिपाना-शून्य-वापसी
'शून्य' के रूप में निर्दिष्ट रिटर्न प्रकार छुपाता है। (डिफ़ॉल्ट दिखाया गया है)

--जिज्ञासा क्वेरी के
केवल वे ऑब्जेक्ट दिखाएं जो किसी विशिष्ट क्वेरी से मेल खाते हों

--शीर्षक शीर्षक
HTML दस्तावेज़ों में एक विशिष्ट शीर्षक जोड़ें

-r, --मुझे पढ़ो, --मुख्य फ़ाइल
रीडमी फ़ाइल का उपयोग दस्तावेज़ीकरण के शीर्षक पृष्ठ के रूप में किया जाता है।

--फ़ाइलें फ़ाइल1,फ़ाइल2, ...
शामिल की जाने वाली कोई भी अतिरिक्त अल्पविराम से अलग की गई स्थैतिक फ़ाइलें (उदा. अक्सर पूछे जाने वाले प्रश्न)

--संपत्ति से[:सेवा मेरे]
जनरेट करने के बाद आउटपुट डायरेक्टरी में कॉपी करने के लिए एक फ़ाइल या निर्देशिका

-o, --आउटपुट-डीआईआर पथ
आउटपुट निर्देशिका. (डिफ़ॉल्ट ./doc पर)

-m, --मार्कअप मार्कअप
दस्तावेज़ीकरण में उपयोग की जाने वाली मार्कअप शैली, जैसे टेक्सटाइल, मार्कडाउन या आरडीओसी (आरडीओसी पर डिफ़ॉल्ट)।

-M मार्कअप_प्रदाता
मार्कअप को संसाधित करने के लिए उपयोग की जाने वाली लाइब्रेरी को ओवरराइड करता है

--मार्कअप-प्रदाता
स्वरूपण (रत्न का नाम निर्दिष्ट करें)

--चारसेट पूर्वी नौसेना कमान
फ़ाइलों को पार्स करते समय उपयोग के लिए कैरेक्टर सेट (डिफ़ॉल्ट सिस्टम लोकेल है)

-t, --टेम्पलेट खाका
उपयोग करने के लिए टेम्पलेट. (डिफ़ॉल्ट रूप से "डिफ़ॉल्ट")

-p, --टेम्पलेट-पथ पथ
टेम्प्लेट देखने के लिए टेम्प्लेट पथ (-t के साथ प्रयुक्त)।

-f, --प्रारूप FORMAT
टेम्प्लेट के लिए आउटपुट स्वरूप (एचटीएमएल पर डिफ़ॉल्ट)।

--नो-आँकड़े
आँकड़े मत छापो

--लोकेल स्थानीय
जेनरेट किए गए दस्तावेज़ के लिए स्थान (डिफ़ॉल्ट रूप से एन)।

--पो-दिर डीआईआर
वह निर्देशिका जिसमें .po फ़ाइलें हैं (डिफ़ॉल्ट रूप से #{YARD::Registry.po_dir})।

टैग विकल्प हैं:
(टैग:शीर्षक की तरह लगता है: 'अधिभार:अतिभारित विधि')

--उपनाम टैग:शीर्षक
एक नया फ्री-फॉर्म मेटाडेटा @tag पंजीकृत करता है

--प्रकार-टैग टैग:शीर्षक
वैकल्पिक प्रकार फ़ील्ड के साथ टैग करें

--प्रकार-नाम-टैग टैग:शीर्षक
वैकल्पिक प्रकार और नाम फ़ील्ड के साथ टैग करें

--नाम टैग टैग:शीर्षक
नाम फ़ील्ड के साथ टैग करें

--शीर्षक-टैग टैग:शीर्षक
शीर्षक फ़ील्ड के रूप में पहली पंक्ति के साथ टैग करें

--छिपाएँ-टैग टैग
टेम्प्लेट से पहले से परिभाषित टैग छुपाता है

--संक्रमणीय-टैग टैग
किसी टैग को संक्रमणीय के रूप में चिह्नित करता है

--गैर-संक्रमणीय-टैग टैग
किसी टैग को संक्रमणीय नहीं के रूप में चिह्नित करता है

अन्य विकल्प हैं:
-e, --भार फ़ाइल
कमांड चलाने से पहले लोड करने के लिए एक रूबी स्क्रिप्ट।

--लगाना लगाना
एक यार्ड प्लगइन लोड करें (`यार्ड-' उपसर्ग वाला रत्न)

--विरासत
पुरानी शैली के रूबी पार्सर और हैंडलर का उपयोग करें। 1.8.x में हमेशा चालू।

--सुरक्षित
इस उदाहरण के लिए सुरक्षित मोड सक्षम करें

-q, --शांत
कोई चेतावनी न दिखाएँ.

--शब्दशः
अधिक जानकारी दिखाएँ.

- दाढ़
डिबगिंग जानकारी दिखाएँ.

--बैकट्रेस
स्टैक ट्रेस दिखाएँ

-v, --संस्करण
संस्करण दिखाएं।

-h, --मदद
यह मदद दिखाओ।

उदाहरण

यार्डोक -o "दस्तावेज़ीकरण/" - "अक्सर पूछे जाने वाले प्रश्न" "लाइसेंस"

उपरोक्त उदाहरण "lib/**/*.rb" में फ़ाइलों के लिए दस्तावेज़ीकरण को "documentation/" में आउटपुट करता है
अतिरिक्त फ़ाइलें "एफएक्यू" और "लाइसेंस" सहित।

onworks.net सेवाओं का उपयोग करके यार्डोक का ऑनलाइन उपयोग करें