Tag: jsdoc

生成jsdoc文档: 我search了解如何操作javascript文档的生成器jsdoc。当我使用它时，我总是将所有的文档文件放在index.js文件中，而从来没有在文件，类或模块中导航（在文档网站中）。此外，我也有一些标签没有出现在文档中。但是，我只使用usejsdoc网站（ jsdoc的文档）给出的标签。版本： Node.js：6.9.1 jsdoc：3.4.2 生成文档的视图 Server.js "use strict"; /** * @module server * @file * The main file of this server. It create access routes. To use it, you can write on a terminal : $ node server.js <br /> * Turn in javascript strict mode. <br /> * * […]

如何在mixins上的extends / inherit情况下正确地为Node.js模块定义JSDoc: 我有三个Node.js模块。一个被调用的user从base模块获得inheritance。 handler模块与user一个实例交互：基本模块 – 获得inheritance： /** * Base module */ 'use strict'; const _ = require("underscore"); module.exports = { name: "base", /** * Extent object helper */ extend: function(child) { return _.extend({}, this, child); }, /** * Delegate event method */ delegate: function () { //some delegate event } }; 用户模块 – 像一个模型： /** […]

jsdoc3中事件标记的工作示例: 有人可以给我一个关于如何正确使用@event标签的例子。我已经看了这里的jsdoc3文档： http ://usejsdoc.org/tags-event.html，但我无法得到它的工作。我正在使用nodejs，并在MyClass / index.js中有一个模块，它通过MyClass的名称导出构造函数： module.exports = MyClass; myClass = function () { … }; 我试图添加 /** * Snowball event. * @event MyClass#snowball */ 在编译的文档中， snowball出现在全局事件列表中，但是当我点击它时，它告诉我 The requested URL /{path-to-my-docs}/MyClass.html was not found on this server. 提前致谢。

用于使用node.js模块完成代码的WebStorm JSDoc类声明: 我想知道如何在WebStorm 11中正确使用JSDoc来标记node.js应用程序中的类和types以获得代码完成等。例：文件 – 答： function A(){ this.b = true; } A.prototype.doSth = function doSth() { return !this.b; } module.export = new A(); 文件B： var foo = bar(); // returns type of A 现在我想要为“foo”完成代码，所以它build议foo.b，foo.doSth，… 我尝试了很多像@class，@constructor这样的JSDoc条目，并使用@type {A}来定义类似foo /* @type {A} */ var foo = bar(); 但WebStorm不能识别typesA.它没有代码完成，也Ctrl +单击括号中的typesA说：“无法find要去的声明”。任何想法如何正确地做到这一点？

我可以在JSDOC里面有variables吗？: 我有几个函数共享一些基础的数据结构，同时也做了非常不同的事情，抽象并不是一个好主意。文档可能看起来像这样（尽pipe这只是一个小示例，许多方法仅共享一些文档）： /** * Creates an array of objects, with each object containing the average distance that minute. The * objects have the keys **Timestamp** (ms since epoch), **Year** (year in device local time) **Month** ( * month in device local time), **Day** (day in device local time), **Hour** (hour in device local time) * […]

与代码智能感知不与webpack捆绑使用: 我有一个简单的webpackconfiguration。 const path = require('path'); module.exports = { devtool: 'source-map', entry: './src/index.js', output: { libraryTarget: 'commonjs', filename: 'index.js', path: path.resolve(__dirname, 'dist'), }, }; 在构build并将模块上传到npm并在其他项目上使用它们之后， vs代码 IntelliSense不适用于这些模块。 jsdoclogging了模块function。 import { myFunc } from 'myModule'; 要么 const myModule = require('myModule'); Myfunc和myModule没有IntelliSense自动压缩支持或任何其他。如何保持webpack构build后的jsdoc工作？

用于在不同文件中定义的对象的JSdoc: 我在文件A.js中有函数，它接受在其他文件entity.js中定义的say的数组。 A.js function put(persons) { } entities.js function Person(name) { this.name = name; this.age = 10; } 现在，在A.js中，当我为JS方法写JSdoc的时候，我应该怎么input？理想情况下应该是{Person []}，但我不知道应该如何引用，因为它存在于不同的文件中。有一种方法，我可以要求像entity.js文件： – var Person = require('./entities').Person; 然后如果我{Person []}，它的工作原理，但我只是想导入定义只是为了JSDoc？这是唯一的办法吗？

返回的类实例的JSDoctypes: 我使用Node.js有两个模块和一个依赖于它们的脚本： LIB / Bar.js module.exports = class Bar { // .. }; LIB / Foo.js const Bar = require('./Bar.js'); module.exports = class Foo { /** * @return {Bar} A Bar instance */ get someBar() { return new Bar(); } }; main.js const Foo = require('./lib/Foo.js'); checkFoo(new Foo()); /** * @param {Foo} foo A Foo instance […]

创buildNPM包，如何logging它们？: 我正在创build一些NPM包，我想知道为他们编写用户文档的最佳做法是什么（因为只有很less的信息，并且search与npm package documentation相关的任何内容都不可避免地产生npm docs自己）。当你发布一个包时，registry从哪里得到头版文件？我想有一个很好的README.md文件是任何浏览github回购的人的第一步，但我想提供一个方便的方式来阅读编译的JsDoc。

JSDoc3＆NodeJS链接到模块的types: 我试图find如何让JSDoc3自动生成从其他模块的类的链接。我觉得很难用文字来解释，所以让我举一些例子。以下脚本将生成预期的输出： /** * @constructor */ var SomeClass = function(){} /** * @param {SomeClass} someParam description */ var someFunc = function(someParam){} 也就是说，JSDoc3正确地生成了从someFunc的参数列表到SomeClass的类描述的链接。但是，当我把SomeClass放在外部模块中，我似乎无法让JSDoc3生成链接： /** * @file SomeClass.js * @module SomeClass */ /** * @constructor */ exports.SomeClass(){} /** * @file main.js */ var SomeClass = require('./SomeClass'); /** * @param {SomeClass} someParam description */ function someFunc(someParam){} […]