Tùy chọn nào có sẵn để ghi lại mã Javascript của bạn?

Question

Có điều gì giống như dOxygen/Javadoc không? Mọi người đã sử dụng cái gì ở đó đã hoạt động tốt?

Answer 1

Khỉ đột 800 pound tài liệu Javascript là JSDoc Toolkit và người kế thừa là JSDoc 3. Hầu hết tài liệu được thực hiện với các thẻ giống như Javadoc và tiền tố nhận xét /**.

Ví dụ:

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

Như đã trình bày trong this liên kết:

Có một phương pháp có sử dụng mã giả trong cú pháp java để ghi lại javascript ..

1. Sử dụng một kịch bản để nhận được tất cả các mã giả từ các tệp .js và tạo các tệp .java có cùng tên, tập lệnh được đính kèm dưới đây có tên là builddoc. Tập lệnh này thực sự có tất cả các dòng bắt đầu bằng ‘///’, ‘/ * ’, ‘/‘, ‘*‘, ‘/’ và ‘//’ vào tệp .java. Vì vậy, một tập tin javascript như

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

sẽ được chuyển đổi thành

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

Và bây giờ Doxygen có thể xử lý nó trong java cách. Bạn nên sử dụng FILE_PATTERNS = * .java trong cấu hình doxygen để cho doxygen phân tích cú pháp tất cả các tệp .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