JSDOC 文档在模块内运行
jsdoc documentation functions inside module
我有以下代码:
/**
* @fileOverview Various tool functions.
* @version 3.1.2
*/
define(function (require, exports, module) {
"use strict";
/**
* A module that handles file
* @module fileHandler
*/
/// Form to open a new set of files
var newFileForm = require("pvsioweb/forms/newFileForm");
var formEvents = require("pvsioweb/forms/events");
/// Reference to current project, main.js passes it by using fileHandler_setProject
var currentProject;
/**
* this is a function
* @param p1 First parameter
* @param p2 Second parameter
* @return {String} some value
*/
function setProject(project)
{
currentProject = project;
}
/**
* Create a new file, it is going to be shown in the listview: #pvsFiles
*
* @param name: name of the file
* @param content: textual content of the file
*
* @returns void
*
*/
function new_file(name, content )
{
var default_name = "MyTheory.pvs";
var default_content = "MyTheory" + " THEORY BEGIN 'nEND MyTheory" ;
if( ! name ) { name = default_name; }
if( ! content ) { content = default_content; }
currentProject.addSpecFile(default_name, default_content);
renderSourceFileList(currentProject.pvsFiles());
}
/**
* Display new file form, invoke function open_file (see below)
*
* @returns void
*
*/
function open_file_form()
{
newFileForm.create().addListener(formEvents.FormCancelled, function (e) {
console.log(e);
e.form.remove();
}).addListener(formEvents.FormSubmitted, function (e) {
console.log(e);
e.form.remove();
open(e.formJSON);
});
}
/**
* Open file specified in data, data must have this structure: ???? FIXME
*
* @param data: ??? FIXME
*
* @returns void
*
*/
function open_file(data)
{
var q = queue(), i;
for (i = 0; i < data.pvsSpec.length; i++) {
q.defer(createFileLoadFunction(data.pvsSpec[i]));
}
q.awaitAll(function (err, res) {
currentProject.saveNew(function (err, res) {
console.log({err: err, res: res});
renderSourceFileList(currentProject.pvsFiles());
});
});
}
/********* Exported Function ******************/
module.exports = {
new_file: function (name, content) {
return new_file(name, content);
},
open_file_form: function () {
return open_file_form();
},
open_file: function () {
return open_file();
},
setProject: function (project) {
return setProject(project);
}
};
/***********************************************/
});
我尝试使用 jsdoc 进行一些输出,但它似乎只识别单词模块和文件开头的标头。
如何修复以查看有关函数的文档?
谢谢
我不确定我是否理解这个问题。您是否正在尝试使用 jsdoc 生成文档?如果是这样,您需要为每个函数添加 jsdoc 注释。此外,您的导出可以大大简化:
module.exports = {
new_file: new_file,
open_file_form: open_file_form,
open_file: open_file,
setProject: setProject
};
相关文章:
- module.js在运行iron节点时找不到模块
- 是否可以从javascript文件中将量角器作为模块运行
- 编写在浏览器和node.js中运行的模块化ECMAScript
- 如何在节点模块中从命令行运行函数
- 如何测试运行 node-fluent-ffmpeg(异步模块)的自定义模块
- 多次使用RequireJS模块不会运行
- 如何防止模块的运行块在测试期间被执行
- 根据当前页面加载和运行Javascript模块
- 使用谷歌地图模块依赖性运行Karma测试
- "npm运行构建“;模块解析错误”;您可能需要一个适当的加载程序来处理此文件类型&”;
- Electron和Typescript:如何在运行时正确处理模块
- 在 ES6 中同步加载其名称在运行时确定的模块
- 可以在模块中运行.导出访问模块中的全局变量
- Nodejs:在任意模块中运行函数
- 节点.js并在运行时/在运行时生成模块
- 如何在 YUI 模块中运行代码
- AngularJS - Grunt:是否存在一种解决方案来构建仅包含所需模块的正在运行的应用程序
- JSDOC 文档在模块内运行
- 如何在 NodeJS 上运行模块
- 为什么我的类在运行时未定义.Javascript 模块模式