Articles of jsdoc

没有Java的JSDoc?

我正在尝试将J SDoc合并到我的Grunt部署过程中。 当我运行它,我得到以下错误(预期): >> JAVA_HOME is not set. Jsdoc requires Java to run. Fatal error: Bad argument 我知道JSDoc是基于Java的,但我希望完全从等式中删除Java。 有没有办法做到这一点与现有的grunt插件,或者另一个只在Node中运行的过程? 我不想只为一个任务添加Java。 这是一个傻瓜的差事吗?

如何用grunt-ngdocs创buildapi文档

我试图通过grunt-ngdocs创buildAPI文档。 部分被创build,但index.html没有正确的链接。 我在我的gruntfile.js中: module.exports = function (grunt) { grunt.initConfig({ pkg: grunt.file.readJSON('package.json'), karma: { unit: { configFile: 'karma.conf.js' } }, uglify: { options: { // the banner is inserted at the top of the output banner: '/*! <%= pkg.name %> <%= grunt.template.today("dd-mm-yyyy") %> */\n' }, dist: { files: { 'web/js/app.min.js': ['web/js/app.js'] } } }, ngdocs: { […]

来自jsdoc的错误消息“没有要处理的input文件”

Jsdoc在本地安装(npm install jsdoc)。 在尝试执行时出现以下错误: .\node_modules.bin\jsdoc –debug ./lib/JavaScriptSource.js输出: DEBUG: JSDoc 3.3.0-dev (Sun, 15 Jun 2014 18:39:52 GMT) DEBUG: Environment info: {"env":{"conf":{"tags":{"allowUnknownTags":true},"templ ates":{"monospaceLinks":false,"cleverLinks":false,"default":{"outputSourceFiles" :true}},"source":{"includePattern":".+\.js(doc)?$","excludePattern":"(^|\/|\\ )_"},"plugins":[]},"opts":{"_":["./lib/JavaScriptSource.js"],"debug":true,"destina tion":"./out/","encoding":"utf8"}}} There are no input files to process. JSDoc 3.3.0-dev(Sun,2014年6月15日18:39:52 GMT) 选项: -t,–template <value>要使用的模板的path。 默认: path/到/ jsdoc /模板/默认 -c,–configure <value>configuration文件的path。 默认:path / to / jsdoc / conf.json ….. </代码>

如何在node.js上运行的脚本中使用jsdoc?

我想用jsdoc模块从一些源代码中提取文档条目。 我已经安装了jsdoc模块,我可以在命令行中使用jsdoc 。 但是当我require("jsdoc")在我的代码中,nodejs抛出一个错误,说Cannot find module 'jsdoc' 。 我有nodejs v0.8.25和JSDoc 3.3.0-alpha2。 它在本地和全球安装。 我可以使用jsdoc命令,我有我的node_modules文件夹中的node_modules 。 我看不出问题在哪里。 在哪里可以find一些关于jsdoc文档, jsdoc不是如何在命令行界面中使用它或者如何loggingjs源代码。 我想要一些API文档。

JSDocs:loggingNode.jsexpression路由

我很努力logging与JSDocs的router.get调用。 我无法获得文档正确显示在页面上,如果我尝试将其附加到我的路由器调用本身。 /** * Health check * @memberof health */ router.get('/happy', function(req, res) { res.json({ "status" : "OK" }); }); 为了解决这个问题,我让function有了名字。 router.get('/happy', happy); /** * Health check * @memberof health */ function happy(req, res) { res.json({ "status" : "OK" }); } 这工作,但我真的想find一种方法来获得第一个方法的工作。 有没有办法logging第一个例子? 我可以使用的关键字?

如何使WebStorm解决模块是function?

WebStorm在parsing从CommonJS模块返回的函数(并读取与之关联的JsDoc)方面做了很好的工作,例如: // utils/valid.js /** * Returns true no matter what. * @param {HTMLElement} element * @return {boolean} */ function isValid(element) { return true; } module.exports.isValid = isValid; // exports property 然后在代码完成和内联文档机制中正确提供这样的function时,在另一个文件中需要这样的模块。 // main.js var isValid = require('./utils/isValid').isValid; // works well 但是,如果函数直接作为模块导出返回,则会失败 // utils/valid.js module.exports = isValid; // exports object is a function 所以当需要这样一个模块时,WebStorm似乎并不知道它是什么: // main.js […]

直接从源代码生成JavaScript文档

我正在寻找一种工具来生成JavaScript函数和属性的文档,即使没有与这些函数或属性(如Doxygen)相关的适当格式的注释块。 JSDoc和其他一些文档工具之间的比较提到,JSDoc可以parsing源代码来生成文档,即使没有注释块(就像我上面提到的Doxygen一样)。 他们说所有其他工具只parsing注释块。 我根据这个指令从npm(在节点上)安装了JSDoc 3.3.0-alpha4,我试图为我的项目生成文档。 据我所见JSDoc不会生成任何文档的function或属性,没有正确的注释与相关的JSDoc标志。 我知道JSDoc已经经历了很多迭代,这个function已经被删除,或者我没有使用正确的开关? 我试图检查命令行选项,但找不到任何开关。 我只是这样使用它: ./node_modules/.bin/jsdoc -r -l my_project –destination doc/ 我知道还有其他工具可以自动添加文档块的代码,例如smartcomments ,但它不是我正在寻找的。 任何人都可以对此有所了解吗?

jsdoc正确的方式来loggingsocket.on('event',function(){})和路由处理程序

如何使用具有以下格式的jsdoc来loggingAPI(单个文件) // api.js exports.addSocketEvents = function(socket) { /** * This will do that and … * @param {Object} data Some data * @param {string} data.bla Something about bla * @param {number} data.n Some number */ socket.on('something_1', function(data) { … }); /** * Another function that will do .. * @param {string} id of something */ […]

用jsdocloggingcallback的正确方法是什么?

我花了很长一段时间在互联网上寻找最好的方式来正确loggingjsdoc的callback,但不幸的是,我还没有find一个好的方法。 这是我的问题: 我正在为开发人员编写一个Node.js库。 这个库提供了开发人员将要使用的多个类,函数和方法。 为了使我的代码清晰易懂,以及(希望)将来会自动生成一些API文档,我已经开始在代码中使用jsdoc来自我logging正在发生的事情。 比方说,我定义了一个如下的函数: function addStuff(x, y, callback) { callback(x+y); }); 使用jsdoc,我目前正在logging这个函数,如下所示: /** * Add two numbers together, then pass the results to a callback function. * * @function addStuff * @param {int} x – An integer. * @param {int} y – An integer. * @param {function} callback – A callback to run […]