jsdoc

7热度

1回答

有一个JavaScript类，使用对象类型的一个参数与定义的属性集和关闭编译器是幸福的，当我将其标注为喜欢： @constructor @param {{ subview:BaseView, el:(jQuery|Element), title:String }} options var MyView = function(options){ } 我想使title键可选的title值传递给

-2热度

1回答

JSDoc通过npm不解析任何评论

我已经从npm安装JSDoc和JSDoc 3工具。 npm install git+https://github.com/jsdoc3/jsdoc.git sudo apt-get install jsdoc-toolkit 成功安装的软件，执行的命令（jsdoc -r = DOC file.js）中，并生成具有文件的文件夹。然而，加价将被忽略，index.html的链接仅仅在于以下路径，

3热度

1回答

如何正确记录需要的module.exports文件不会丢失？

我试图正确地遵循JSDoc guidelines为我所有的代码，它看起来像我正确记录我的构造，使编辑人员能够识别参数：但由于某些原因，当我出口类的，让他们可以在其他地方需要，他们不再在世界各地，认可他们是什么：我缺少的东西在我要导出类的方法或者当用户需要我的图书馆时记录令人困惑的编辑器的导出？ require语句本身正在工作，编辑者无需导航到require语句（'./YLTProfile'）中

0热度

2回答

javascript jsdoc命名空间类静态方法

我想在我想定义的js代码上使用jsDoc： - 命名空间。 - A级。 - 静态方法。注意，代码不正是我希望在运行时，但我有问题，开始使用jsDoc，所以我问自己，如果代码是正确的...... /** @namespace * @name myNamespace * @description myNamespace description. */ if (typeof (myNamesp

3热度

2回答

如何在JSDoc中注释“@ readonly-but-modified-internal”成员/属性？

JSDoc有@readonly doclet tag：的@ReadOnly标签指示符号旨在为只读。例如： /** * The name of the represented principal * @member {string} * @readonly */ this.name = primaryName; 不过，我真正要沟通，文档是大众消费者应该治疗为只读属性 - 但该成员是

1热度

1回答

如何记录（jsduck/jsdoc）cucumber.js步骤的定义？

有没有什么方法可以记录cucumber.js步骤定义代码中的步骤？我试着做jsduck @class效仿： /** * @class Global.steps.common * Common steps. */ var steps = module.exports = function() { /** * Step 1 description. */

3热度

2回答

不能记录枚举

我想记录一个枚举这样的： /** * Enum for the different types of tokens * @memberof Ecre * @enum {number} * @readonly */ Ecre.TokenTypes = Object.freeze({ /** * A string token */ "string":

4热度

1回答

如何将控制器放入ngdoc模块中

我使用grunt grunt-ngdocs模块，这是创建文档的代码。 ngdocs: { all: app_files, scripts: ['angular.js'] } 我有一个模块调用启动器和两个控制器：controllerA，controllerB /** * * @ngdoc object * @name cont

0热度

2回答

未定义方法`[]'为零：NilClass在联系表格

这很奇怪。但是我的联系表单发生故障。我已经实现了相当数量的这些形式和这违背我的推理为什么我在这一行 <%= form_for(@inquiry, :html => {:"data-validate" => 'parsley'}) do |f| %> 及彼undefined method '[]' for nil:NilClass是视图; <%= form_for(@inquiry, :htm

0热度

2回答

如何在自调用函数中记录简单的类？

如何记录下面的代码片段？当我离开它，因为它是Foo.bar没有说明。当我添加@memberof标记时，它将记录为静态属性。添加@instance标签不会改变任何内容。这是相当简单和常见的代码模式，所以它应该很容易记录，对吗？我讨厌jsdoc ... /** * @namespace */ var ns; (function (ns) { 'use strict';