JSDuck - प्रलेखन जनरेटर

प्रलेखन अच्छे कोड का एक अभिन्न अंग है और समग्र रूप से परियोजना है। अच्छा डेवलपर्स प्रलेखन का समर्थन करने में बहुत समय बिताता है, लेकिन भविष्य में यह ब्याज के साथ भुगतान करता है: यह कोड का समर्थन करने, इसे विस्तारित करने और बग को ठीक करने में समय बचाता है, यह नए डेवलपर्स के लिए परियोजना में गोता लगाने के लिए समय कम करने की अनुमति देता है, आदि। इसके अलावा, अच्छी तरह से प्रलेखित कोड स्पष्ट रूप से डेवलपर को कोडिंग मानकों को लागू करने के लिए प्रोत्साहित करता है।

परिचय
स्थापना
विन्यास और शुरू
कोड प्रलेखन
अतिरिक्त प्रलेखन पृष्ठ
एक निष्कर्ष के बजाय

परिचय

विस्तृत दस्तावेज JSDuck परियोजना की वेबसाइट पर उपलब्ध है।
यह लेख JSDuck सुविधाओं और कुछ उपयोग युक्तियों का संक्षिप्त विवरण प्रदान करता है।
जनरेटर का उपयोग उसके मानकों के अनुसार प्रलेखित किसी भी कोड के लिए किया जा सकता है। एक्सटीजेएस पर बनाए गए एप्लिकेशन स्वचालित प्रलेखन का समर्थन करते हैं क्योंकि जनरेटर मूल रूप से सेन्चा के लिए बनाया गया था और एक्सटीजेएस सिंटैक्स मान्यता की अनुमति देता है।
उत्पन्न प्रलेखन बिल्कुल आधिकारिक एक्सटीजेएस दस्तावेज जैसा दिखता है।

स्थापना

gem install jsduck

लिनक्स : आपको रूबी के लिए वैकल्पिक देव पैकेज स्थापित करना होगा। डेबियन को ruby1.9-dev पैकेज (रूबी 1.9) की आवश्यकता है। रेड हैट / सेंटोस / फेडोरा को माणिक-डेवेल की आवश्यकता होती है।
विंडोज : रूबी और विकास किट स्थापित करें

विन्यास और शुरू

जनरेटर को कमांड लाइन से लॉन्च किया जाता है

$ jsduck

इस स्थिति में, संपूर्ण कॉन्फ़िगरेशन को उसी निर्देशिका में स्थित jduck.json फ़ाइल में डिफ़ॉल्ट रूप से वर्णित किया जाना चाहिए।
कॉन्फ़िगरेशन फ़ाइल का उपयोग किए बिना सभी कॉन्फ़िगरेशन पैरामीटर कमांड लाइन पर वर्णित किए जा सकते हैं। उदाहरण के लिए

$ jsduck path/to/src --output docs

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

$ jsduck --config=mypath/to/myconfig.json

कमांड के साथ सभी कमांड लाइन विकल्पों पर मदद देखी जा सकती है

$ jsduck --help

सभी मापदंडों का उपयोग कमांड लाइन और कॉन्फ़िगरेशन फ़ाइल दोनों से किया जा सकता है।

कॉन्फ़िगरेशन फ़ाइल उदाहरण

 { "--title": "My Application Docs", "--warnings": [ "-all:path/to/extjs/src" ], "--output": "docs", "--": [ "path/to/extjs/src", "path/to/my/app" ] } 

मापदंडों का संक्षिप्त विवरण:
शीर्षक - प्रलेखन पृष्ठ पर शीर्षक शीर्षक।
चेतावनियाँ - आपको चेतावनी के प्रवाह को नियंत्रित करने की अनुमति देता है जो कंसोल को लिखे गए हैं यदि दस्तावेज कोड स्वयं से मेल नहीं खाता है। उपरोक्त उदाहरण में, "-all" विकल्प का उपयोग करना सभी चेतावनी को अनदेखा करता है जो एक्सटज फ्रेमवर्क में होती है।
आउटपुट - उत्पन्न प्रलेखन की निर्देशिका।
अंतिम खंड "-" निर्देशिका कोड के साथ निर्देशिकाओं को सूचीबद्ध करता है जिनसे प्रलेखन उत्पन्न किया जाना चाहिए।

कोड प्रलेखन

 /** *   ,         Markdown *  ,   "@" (). */ 

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

कुछ सामान्य मेटा टैग पर विचार करें।

वर्ग

वर्ग का नाम दस्तावेज़।

 /** * @class MyClass *   MyClass. */ 

इसे निम्नलिखित मामलों में स्वचालित रूप से पहचाना जा सकता है।

 /** *    . */ function MyClass() { } /** *    . */ MyApp.MyClass = function() { }; /** *    . */ Ext.define("MyApp.MyClass ", { extend: "Ext.Component", ... }); 

परम

विधियों और घटनाओं के लिए दस्तावेज़ पैरामीटर।

 /** * @param {Type} name   name. */ 

इस गाइड में टाइप डॉक्यूमेंटेशन का वर्णन किया गया है।
पैरामीटर को स्वचालित रूप से पहचाना जा सकता है।

 /** * Sets the width and height of the panel. */ function setSize(width, height) { } 

समतुल्य रूप

 /** * @method setSize * Sets the width and height of the panel. * @param width * @param height */ 

क्रॉस संदर्भ

किसी अन्य वर्ग या वर्ग के सदस्य (गुण, विधि) के लिए एक ब्लॉक के भीतर लिंक को इंगित करने के लिए, {@link} टैग का उपयोग करें। सामान्य प्रारूप:

{@link Class#member link text}

पाठ को छोड़ा जा सकता है, यदि कक्षा का नाम बहुत लंबा है तो इसका उपयोग करना सुविधाजनक है। उदाहरण के लिए लिंक को स्वचालित रूप से पहचाना जा सकता है

 /** *     Office.view.Main.    ExtJS, *      Ext.container.Viewport. */ 

इस उदाहरण में, Office.view.Main और Ext.container.Viewport के लिंक स्वचालित रूप से बनाए जाएंगे।
यदि लिंक वास्तव में मौजूदा कक्षाओं को इंगित नहीं करते हैं, तो कंसोल में एक चेतावनी प्रदर्शित की जाएगी।

मेटा टैग पर अधिक जानकारी के लिए दस्तावेज़ और मार्गदर्शिका देखें।

अतिरिक्त प्रलेखन पृष्ठ

डिफ़ॉल्ट रूप से, जनरेटर एपी एप्लिकेशन के साथ एक पेज बनाता है। JSDuck कॉन्फ़िगरेशन का उपयोग करके, आप अतिरिक्त पृष्ठों को प्रलेखन में जोड़ सकते हैं:

• स्वागत पृष्ठ
• श्रेणी पृष्ठ
• मैनुअल पेज
• उदाहरण के साथ पेज

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

स्वागत पृष्ठ

स्वागत पृष्ठ के उदाहरण के लिए आधिकारिक स्वागत पृष्ठ देखें। यदि आपका प्रोजेक्ट सभी के लिए खुला नहीं है, तो इस पृष्ठ का कोई मतलब नहीं है, इसके द्वारा और बड़े पैमाने पर।

इस पृष्ठ में एक HTML फ़ाइल होती है जिसमें केवल टैग के अंदर कोड होता है

 ,  -  .  
 
 <h1>   !</h1> 
         --welcome    
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... } 
         --head-html .  
 
 "--head-html": '<link rel="stylesheet" href="style.css" type="text/css">' 
    
       . 
        JSON.      ,   --guides 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... } 
 
    jsduck-guides.json 
 
 [ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": "   ", "description": "    ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ] 
     .    ,     
 
 somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png 
      README.md (  Markdown),      .        icon.png   . 
 
    
       . 
      .       .    ,      .  ,      ,     .        ,   .        JSON       JSDuck    --categories 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... } 
  jsduck-cat.json 
 
 [ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ] 
 
  
   
     JSDuck      Siesta .       . 

, - .

<h1> !</h1>
--welcome

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... }
--head-html .

"--head-html": '<link rel="stylesheet" href="style.css" type="text/css">'

.
JSON. , --guides

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... }

jsduck-guides.json

[ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": " ", "description": " ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ]
. ,

somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png
README.md ( Markdown), . icon.png .


.
. . , . , , . , . JSON JSDuck --categories

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... }
jsduck-cat.json

[ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ]



JSDuck Siesta . .

 ,  -  .  
 
 <h1>   !</h1> 
         --welcome    
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... } 
         --head-html .  
 
 "--head-html": '<link rel="stylesheet" href="style.css" type="text/css">' 
    
       . 
        JSON.      ,   --guides 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... } 
 
    jsduck-guides.json 
 
 [ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": "   ", "description": "    ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ] 
     .    ,     
 
 somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png 
      README.md (  Markdown),      .        icon.png   . 
 
    
       . 
      .       .    ,      .  ,      ,     .        ,   .        JSON       JSDuck    --categories 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... } 
  jsduck-cat.json 
 
 [ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ] 
 
  
   
     JSDuck      Siesta .       . 

, - .

<h1> !</h1>
--welcome

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... }
--head-html .

"--head-html": '<link rel="stylesheet" href="style.css" type="text/css">'

.
JSON. , --guides

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... }

jsduck-guides.json

[ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": " ", "description": " ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ]
. ,

somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png
README.md ( Markdown), . icon.png .


.
. . , . , , . , . JSON JSDuck --categories

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... }
jsduck-cat.json

[ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ]



JSDuck Siesta . .

 ,  -  .  
 
 <h1>   !</h1> 
         --welcome    
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... } 
         --head-html .  
 
 "--head-html": '<link rel="stylesheet" href="style.css" type="text/css">' 
    
       . 
        JSON.      ,   --guides 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... } 
 
    jsduck-guides.json 
 
 [ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": "   ", "description": "    ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ] 
     .    ,     
 
 somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png 
      README.md (  Markdown),      .        icon.png   . 
 
    
       . 
      .       .    ,      .  ,      ,     .        ,   .        JSON       JSDuck    --categories 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... } 
  jsduck-cat.json 
 
 [ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ] 
 
  
   
     JSDuck      Siesta .       . 

, - .

<h1> !</h1>
--welcome

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... }
--head-html .

"--head-html": '<link rel="stylesheet" href="style.css" type="text/css">'

.
JSON. , --guides

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... }

jsduck-guides.json

[ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": " ", "description": " ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ]
. ,

somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png
README.md ( Markdown), . icon.png .


.
. . , . , , . , . JSON JSDuck --categories

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... }
jsduck-cat.json

[ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ]



JSDuck Siesta . .

, - .

<h1> !</h1>
--welcome

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... }
--head-html .

"--head-html": '<link rel="stylesheet" href="style.css" type="text/css">'

.
JSON. , --guides

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... }

jsduck-guides.json

[ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": " ", "description": " ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ]
. ,

somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png
README.md ( Markdown), . icon.png .


.
. . , . , , . , . JSON JSDuck --categories

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... }
jsduck-cat.json

[ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ]



JSDuck Siesta . .

, - .

<h1> !</h1>
--welcome

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... }
--head-html .

"--head-html": '<link rel="stylesheet" href="style.css" type="text/css">'

.
JSON. , --guides

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... }

jsduck-guides.json

[ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": " ", "description": " ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ]
. ,

somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png
README.md ( Markdown), . icon.png .


.
. . , . , , . , . JSON JSDuck --categories

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... }
jsduck-cat.json

[ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ]



JSDuck Siesta . .

 ,  -  .  
 
 <h1>   !</h1> 
         --welcome    
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... } 
         --head-html .  
 
 "--head-html": '<link rel="stylesheet" href="style.css" type="text/css">' 
    
       . 
        JSON.      ,   --guides 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... } 
 
    jsduck-guides.json 
 
 [ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": "   ", "description": "    ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ] 
     .    ,     
 
 somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png 
      README.md (  Markdown),      .        icon.png   . 
 
    
       . 
      .       .    ,      .  ,      ,     .        ,   .        JSON       JSDuck    --categories 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... } 
  jsduck-cat.json 
 
 [ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ] 
 
  
   
     JSDuck      Siesta .       . 

, - .

<h1> !</h1>
--welcome

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... }
--head-html .

"--head-html": '<link rel="stylesheet" href="style.css" type="text/css">'

.
JSON. , --guides

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... }

jsduck-guides.json

[ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": " ", "description": " ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ]
. ,

somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png
README.md ( Markdown), . icon.png .


.
. . , . , , . , . JSON JSDuck --categories

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... }
jsduck-cat.json

[ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ]



JSDuck Siesta . .

 ,  -  .  
 
 <h1>   !</h1> 
         --welcome    
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... } 
         --head-html .  
 
 "--head-html": '<link rel="stylesheet" href="style.css" type="text/css">' 
    
       . 
        JSON.      ,   --guides 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... } 
 
    jsduck-guides.json 
 
 [ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": "   ", "description": "    ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ] 
     .    ,     
 
 somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png 
      README.md (  Markdown),      .        icon.png   . 
 
    
       . 
      .       .    ,      .  ,      ,     .        ,   .        JSON       JSDuck    --categories 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... } 
  jsduck-cat.json 
 
 [ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ] 
 
  
   
     JSDuck      Siesta .       . 

, - .

<h1> !</h1>
--welcome

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... }
--head-html .

"--head-html": '<link rel="stylesheet" href="style.css" type="text/css">'

.
JSON. , --guides

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... }

jsduck-guides.json

[ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": " ", "description": " ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ]
. ,

somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png
README.md ( Markdown), . icon.png .


.
. . , . , , . , . JSON JSDuck --categories

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... }
jsduck-cat.json

[ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ]



JSDuck Siesta . .

 ,  -  .  
 
 <h1>   !</h1> 
         --welcome    
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... } 
         --head-html .  
 
 "--head-html": '<link rel="stylesheet" href="style.css" type="text/css">' 
    
       . 
        JSON.      ,   --guides 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... } 
 
    jsduck-guides.json 
 
 [ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": "   ", "description": "    ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ] 
     .    ,     
 
 somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png 
      README.md (  Markdown),      .        icon.png   . 
 
    
       . 
      .       .    ,      .  ,      ,     .        ,   .        JSON       JSDuck    --categories 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... } 
  jsduck-cat.json 
 
 [ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ] 
 
  
   
     JSDuck      Siesta .       . 

, - .

<h1> !</h1>
--welcome

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... }
--head-html .

"--head-html": '<link rel="stylesheet" href="style.css" type="text/css">'

.
JSON. , --guides

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... }

jsduck-guides.json

[ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": " ", "description": " ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ]
. ,

somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png
README.md ( Markdown), . icon.png .


.
. . , . , , . , . JSON JSDuck --categories

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... }
jsduck-cat.json

[ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ]



JSDuck Siesta . .

, - .

<h1> !</h1>
--welcome

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... }
--head-html .

"--head-html": '<link rel="stylesheet" href="style.css" type="text/css">'

.
JSON. , --guides

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... }

jsduck-guides.json

[ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": " ", "description": " ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ]
. ,

somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png
README.md ( Markdown), . icon.png .


.
. . , . , , . , . JSON JSDuck --categories

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... }
jsduck-cat.json

[ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ]



JSDuck Siesta . .

, - .

<h1> !</h1>
--welcome

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... }
--head-html .

"--head-html": '<link rel="stylesheet" href="style.css" type="text/css">'

.
JSON. , --guides

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... }

jsduck-guides.json

[ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": " ", "description": " ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ]
. ,

somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png
README.md ( Markdown), . icon.png .


.
. . , . , , . , . JSON JSDuck --categories

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... }
jsduck-cat.json

[ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ]



JSDuck Siesta . .

 ,  -  .  
 
 <h1>   !</h1> 
         --welcome    
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... } 
         --head-html .  
 
 "--head-html": '<link rel="stylesheet" href="style.css" type="text/css">' 
    
       . 
        JSON.      ,   --guides 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... } 
 
    jsduck-guides.json 
 
 [ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": "   ", "description": "    ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ] 
     .    ,     
 
 somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png 
      README.md (  Markdown),      .        icon.png   . 
 
    
       . 
      .       .    ,      .  ,      ,     .        ,   .        JSON       JSDuck    --categories 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... } 
  jsduck-cat.json 
 
 [ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ] 
 
  
   
     JSDuck      Siesta .       . 

, - .

<h1> !</h1>
--welcome

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... }
--head-html .

"--head-html": '<link rel="stylesheet" href="style.css" type="text/css">'

.
JSON. , --guides

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... }

jsduck-guides.json

[ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": " ", "description": " ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ]
. ,

somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png
README.md ( Markdown), . icon.png .


.
. . , . , , . , . JSON JSDuck --categories

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... }
jsduck-cat.json

[ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ]



JSDuck Siesta . .

 ,  -  .  
 
 <h1>   !</h1> 
         --welcome    
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... } 
         --head-html .  
 
 "--head-html": '<link rel="stylesheet" href="style.css" type="text/css">' 
    
       . 
        JSON.      ,   --guides 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... } 
 
    jsduck-guides.json 
 
 [ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": "   ", "description": "    ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ] 
     .    ,     
 
 somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png 
      README.md (  Markdown),      .        icon.png   . 
 
    
       . 
      .       .    ,      .  ,      ,     .        ,   .        JSON       JSDuck    --categories 
 
 { "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... } 
  jsduck-cat.json 
 
 [ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ] 
 
  
   
     JSDuck      Siesta .       . 

, - .

<h1> !</h1>
--welcome

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... }
--head-html .

"--head-html": '<link rel="stylesheet" href="style.css" type="text/css">'

.
JSON. , --guides

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... }

jsduck-guides.json

[ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": " ", "description": " ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ]
. ,

somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png
README.md ( Markdown), . icon.png .


.
. . , . , , . , . JSON JSDuck --categories

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... }
jsduck-cat.json

[ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ]



JSDuck Siesta . .

, - .

<h1> !</h1>
--welcome

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... }
--head-html .

"--head-html": '<link rel="stylesheet" href="style.css" type="text/css">'

.
JSON. , --guides

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... }

jsduck-guides.json

[ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": " ", "description": " ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ]
. ,

somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png
README.md ( Markdown), . icon.png .


.
. . , . , , . , . JSON JSDuck --categories

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... }
jsduck-cat.json

[ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ]



JSDuck Siesta . .

, - .

<h1> !</h1>
--welcome

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", ... }
--head-html .

"--head-html": '<link rel="stylesheet" href="style.css" type="text/css">'

.
JSON. , --guides

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", ... }

jsduck-guides.json

[ { "title": "", "items": [ { "name": "config", "url": "guides/config", "title": " ", "description": " ." }, { "name": "components", "url": "guides/components", "title": "", "description": " ." } ] } ]
. ,

somedir/ jsduck-guides.json guides/ config/ README.md icon.png some-image.png components/ README.md icon.png
README.md ( Markdown), . icon.png .


.
. . , . , , . , . JSON JSDuck --categories

{ "--title": "My Application Docs", "--welcome": "path/to/my/welcome.html", "--guides": "jsduck-guides.json", "--categories": "jsduck-cat.json", ... }
jsduck-cat.json

[ { "name": "MyApp base classes", "groups": [ { "name": "Application", "classes": [ "MyApp .Application", "MyApp .controller.Main", "MyApp .view.Main" ] }, { "name": "View", "classes": [ "MyApp .view.*.*" ] }, { "name": "Widgets", "classes": [ "MyApp .widget.*" ] }, ... ] }, ... ]



JSDuck Siesta . .