Jakie narzędzia są dostępne do dokumentowania wtyczek jQuery?

Question

Niedawno zacząłem tworzyć niektóre wtyczki jQuery i trudno jest je udokumentować za pomocą narzędzi do generowania dokumentacji, które znalazłem. Próbowałem: JSDoc, JSDoc-toolkit, JGrouse i narzędzie internetowe. Moją największą bolączką jest to, że moje wtyczki są kodowane jako jedna wielka anonimowa funkcja, i mam problemy z uzyskaniem narzędzi do rozpoznania tego, co robię, lub zignorowania go w całości i pozwolę sobie wpisać znaczniki dokumentacji dla metod , obiekty itp.

Czy są jakieś inne narzędzia, które mogą pomóc w dokumentowaniu wtyczek jQuery?

Dzięki, Sandro

Answer 1

Miałeś spojrzeć na Natural Docs? Może to nie mieć wyraźnego wsparcia dla JavaScript, ale i tak robi to całkiem dobrze. Oczywiście możesz oszukać go, żeby nie rozumieć kodu, ale jeśli dobrze z nim pograsz, może to być piekielne narzędzie.

Answer 2

Javascript narzędzia dokumentacja są nadal stosunkowo niedojrzały, więc nie ma 50+ jak te istnieją dla powiedzmy JavaDoc, a te, które nie istnieją, nie obsługiwać skomplikowanych przypadków, takich jak wtyczki jQuery -ins (a przynajmniej żaden z tych, które widziałem).

Jednak JavaScript jest niezwykle elastycznym językiem, więc możesz może po prostu przepisać swoje wtyczki w sposób, który sprawia, że ​​narzędzie do dokumentacji jest szczęśliwy.

Na przykład, zamiast:

(function($) { 
    $.yourMethod = function() {/* do something */} 
})(jQuery); 

można zrobić:

function yourMethod = function() { 
    /* do something */ 
} 

(function($) { 
    $.yourMethod = yourMethod; 
})(jQuery); 
delete yourMethod 

lub po prostu:

jQuery.yourMethod = function() { 
    /* do something */ 
} 

te dwie opcje nie są naprawdę identyczne; pierwszy nadpisze istniejącą funkcję yourMethod, a druga nie będzie miała "prywatności" standardowego formatu wtyczki. W zależności od tego, co pisze ta wtyczka, problemy te mogą lub nie mają znaczenia dla Ciebie.

Jeśli tak się nie stanie, zmiana stylu kodu może być realistycznym sposobem na parsowanie JSDoc. Jeśli nie ... powodzenia znalezienie wystarczająco dojrzałe narzędzie JSDoc (lub pisząc własne) :-)

Answer 3

używam programu Visual Studio XML komentarze: http://weblogs.asp.net/bleroy/archive/2007/04/23/the-format-for-javascript-doc-comments.aspx

Answer 4

użyłem doxygen ten sposób:

/** @cond */ 

jQuery(function($){ 

    $.fn.TestFunction = function(){ testvar="test1";test("test2");alert(testvar); } 

/** @endcond */ 

    /** DoSth Function */ 
    function test(testvar) 
    { 
     alert(testvar); 
     var testvar="test3"; 
     alert(testvar); 
    } 

/** @cond */ 

    delete test; 
}); 

/** @endcond */