問題描述
我最近開始創(chuàng)建一些 jQuery 插件,我發(fā)現(xiàn)很難使用我找到的文檔生成工具來記錄它們.我試過了:JSDoc, JSDoc-toolkit、JGrouse 和一個(gè)基于網(wǎng)絡(luò)的工具還.我最頭疼的是我的插件被編碼為一個(gè)大的匿名函數(shù),我無法讓工具識別我在做什么,或者完全忽略它,讓我輸入方法的文檔標(biāo)簽、對象等.
I've recently started creating some jQuery plugins and I'm finding it difficult to document them with the documentation generating tools that I've found. I've tried: JSDoc, JSDoc-toolkit, JGrouse and a web-based tool also. My biggest headache is that my plug-ins are coded as one big anonymous function, and I'm having trouble getting the tools to either recognize what I'm doing, or ignore it altogether and let me type in the documentation tags for the methods, objects, etc..
還有其他工具可以幫助記錄 jQuery 插件嗎?
Are there any other tools that might help with documenting jQuery plugins?
謝謝,桑德羅
推薦答案
你看過Natural Docs?它可能對 JavaScript 沒有太多明確的支持,但無論如何它都做得很好.當(dāng)然你可以欺騙它讓它不理解代碼,但如果你玩得很好,它可能是一個(gè)地獄般的工具.
Have you had a look at Natural Docs? It might not have very much of explicit support for JavaScript, however it does a quite good job anyway. Of course you can trick it not to understand the code, but if you play nice with it, it can be a hell of a tool.
這篇關(guān)于哪些工具可用于記錄 jQuery 插件?的文章就介紹到這了,希望我們推薦的答案對大家有所幫助,也希望大家多多支持html5模板網(wǎng)!