आपके जावास्क्रिप्ट कोड को दस्तावेज़ित करने के लिए कौन से विकल्प उपलब्ध हैं?

Question

क्या डॉक्सीजन/जावाडोक की तरह कुछ है? हर किसी ने क्या किया है जिसने अच्छी तरह से काम किया है?

Answer 1

जावास्क्रिप्ट दस्तावेज का 800-पाउंड गोरिल्ला JSDoc Toolkit और इसके उत्तराधिकारी JSDoc 3 है। अधिकांश दस्तावेज जवाडोक-जैसे टैग और /** टिप्पणी उपसर्ग के साथ किए जाते हैं।

उदाहरण:

var MyClass = Class.create(
    /** @lends MyClass# */    // @lends is how you document anonymous classes. 
    { 
    /** 
    * Description of constructor. 
    * @class Description of class. // @class annotation goes anywhere and 
    *        // describes the whole class. 
    * @constructs     // This is a constructor. 
    */ 
    initialize: function(arg0, arg1) { 
     //... 
    }, 

    /** A method. */ 
    myFunc: function() {}, 

    /** An instance field. */ 
    myVar: 123 
    } 
); 

Object.extend(MyClass, 
    /** @lends MyClass */ 
    { 
    /** A class method. */ 
    classFunc: function() {} 
    } 
); 

Answer 2

this लिंक में वर्णित है: एक स्क्रिप्ट

किसी अन्य विधि जावा वाक्य रचना में छद्म कोड का उपयोग करता है जावास्क्रिप्ट दस्तावेज़ के लिए नहीं है ..

1. उपयोग .js फ़ाइलों से सभी छद्म कोड प्राप्त करें और उसी नाम से .java फ़ाइलों को जेनरेट करें, स्क्रिप्ट को बिल्डडोक नामक बेलो संलग्न किया गया है। इस स्क्रिप्ट में वास्तव में सभी पंक्तियां '///', '/ * ', '/', '*', '/' और '//' से .java फ़ाइल में शुरू होती हैं। तो जैसे

   //* package ns; 
   /** 
   * Foo. 
   * @param foo foo. 
   */ 
   var foo=function(foo){} 
   //* public void foo(String foo); 
   

एक जावास्क्रिप्ट फ़ाइल

package ns; 
/** 
* Foo. 
* @param foo foo. 
*/ 
public void foo(String foo); 

में बदल दिया जाएगा और अब Doxygen जावा तरीके से संसाधित कर सकें। आपको सभी .java फ़ाइलों को पार्स करने के लिए डॉक्सिजन को बताने के लिए FILE_PATTERNS = * .java को अपने डॉक्सिजन कॉन्फ़िगरेशन में उपयोग करना चाहिए।

builddoc:

#!/bin/bash 

DIRs="./" 

if [ $# -ne 0 ] 
then 
    DIRs=$@ 
fi 

for DIR in $DIRs; do 

    JSs=`find $DIR -name "*.js"` 

    for JS in $JSs; do 
    DOC=`echo $JS|sed 's/\(.*\)\.js/\1.java/g'`; 
    if [ $JS -nt $DOC ]; then 
     echo "rebuild $DOC" 
     grep -e '^\s*\(///\|//\*\|/\*\*\| \* \| \*/\)' $JS | sed 's/^\s*\/\/\*\(.*\)$/\1/g'> $DOC 
    fi 
done 

done