我最近开始创建一些jQuery插件,我发现很难用我找到的文档生成工具来记录它们。我试过了:JSDoc,JSDoc-toolkit,JGrouse,还有一个基于网络的工具。我最头疼的是我的插件被编码成一个大的匿名函数,而我无法让工具识别我在做什么,或者完全忽略它,让我输入方法、对象等的文档标记。
有没有其他工具可以帮助记录jQuery插件?
谢谢,桑德罗
发布于 2010-08-03 21:38:00
你看过Natural Docs吗?它可能没有太多对JavaScript的显式支持,但不管怎样,它都做得很好。当然,你也可以欺骗它,让它不理解代码,但如果你玩得很好,它可能是一个地狱般的工具。
发布于 2011-02-28 20:24:57
我是这样使用doxygen的:
/** @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 */
发布于 2010-07-29 02:57:18
我使用Visual Studio XML注释:http://weblogs.asp.net/bleroy/archive/2007/04/23/the-format-for-javascript-doc-comments.aspx
https://stackoverflow.com/questions/1639234
复制相似问题