jsdoc3

1热度

1回答

如何在HTML模板（jsdoc/grunt-jsdoc）中处理javascript代码

jsdoc没有解析<script>内容（有效JS与有效的JSDOC注释）。如何解决？是否可以扫描html文件和文件内的代码脚本标签？ jsdoc: { dist: { src: ['assets/js/**/*.js', 'templates/users/*.html', 'README.md'], options: { destination

1热度

1回答

JSDoc 3失败，信息不明

我使用JSdoc 3.3.3生成文档。我得到了以下错误消息： Generating output files...org.mozilla.javascript.EcmaError: SyntaxError: Unterminated parenthetical (<eval'ed string>#1(Function)#201(Function)#53(Function)#17) 我没有从哪

1热度

2回答

JSDOC和揭示模块模式

我有返回对象的函数。我希望把他们的jsdoc定义在webstorm intellisense上看到他们的属性和方法。我该如何编写jsdoc的以下函数？ function MyOtherFunc() { return { a:'for eg string', b:12 } } function MyFunc() { var prop = MyOtherFunc();

3热度

2回答

评论Angular 2/Ionic 2项目与JSDoc

我想使用JSDoc开始记录我的Ionic 2应用程序，但我很难与Angular 2的语法一起使用它。例如，我有我的应用程序的顶部下面的代码： import {App, Events, IonicApp, Platform} from 'ionic-framework/ionic'; import {UserData} from './providers/user-data'; @App({

1热度

1回答

如何获得链接到索引页面出现

我已经开始使用jsdoc和jaguarjs-jsdoc来为我的API使用节点生成文档。它工作得很好，我甚至可以使用readme.md文件来生成索引页面，但我似乎无法获取到索引页面的链接，以便出现在搜索栏see example site上方的左上角。我正在运行的命令是这样的。 $ ./node_modules/.bin/jsdoc ./README.md ./app/ -r -t ./node_m

3热度

2回答

如何在jsdoc中写属性的默认值的空间

我无法找到在JSDOC中记录属性默认值时打印空间的方法。例如： /** * @prop {string} str='String with space' - The string. */ 这将被记录为： Name Type Default Description str string 'String with space' - The string 任何建议如何做正确的吗？

9热度

1回答

AMD + Backbone + JSDoc3文档的最佳途径

我正在寻找记录我的代码的最佳方式，但我没有找到任何东西。我已经看到其他主题，其中包括this，但这些都不能解决我的问题。我有这样的事情： define([ 'backbone' ], function (Backbone) { /** * @module models/products */ /** * Product mode

2热度

1回答

在angularJS中使用带有控制器属性的ngdocs

我刚开始学习如何使用grunt-ngdocs来处理我的角度应用程序，并且非常好。但我现在想在我的一个控制器中记录另一个记录属性的一些属性。考虑下面的代码： (function() { 'use strict'; /** * @ngdoc controller * @name app.mymodule.controller:MyController

3热度

1回答

在大型应用程序中使用JsDoc3，如何将模块分组为段/类别/子模块

我正在研究一个应用程序，这个应用程序将会变得相当庞大。我决定使用JsDoc3和DocStrap来记录所有模块。模块是通过require.js定义的，并且在一些地方它们嵌套深达3或4级。直到现在我明白，JsDoc文档分为四个主要部分：模块，类，教程，全局。每个部分都有一个标题下拉菜单和一个侧栏，每个部分按字母顺序列出所有以liniar方式显示的模块。我想知道是否有选项来显示/分组模块和类以某种方式

1热度

2回答

JSDOC：如何文档的功能

内部变量是否有办法有JSDOC没有功能之前，使用@namespace注释的功能里面显示的变量？我做了一个小测试对象，但它只会显示最后一个函数的内部变量k，它被声明为一个名称空间。我想到了用@memberof！注释和详细@name注释将显示在下面称为DIFF第二种方法内可变。我运行的命令jsdoc3与选项--access“所有” --explain。下面是测试对象的代码： (function()