jsdoc

    1热度

    1回答

    在我的角类(打字稿)我有一个构造函数: constructor(public http: Http) { [...] } 这是正确的方式进行jsDoc评论此构造函数的参数? /** * @constructor * @param {Http} Http service * called when the ApiService is create

    0热度

    1回答

    一个如何使用@param暗示的可选 PARAM用于function这是一个属性(this.selectedPage())以及使用@type提示其返回类型? 借此例如(this.selectedPage()可以通过传递一个参数接收寻呼并通过使无返回一个): /** * @type {function(): Page} */ this.selectedPage = ko.observable(d

    1热度

    1回答

    我想为我正在构建的框架创建一个自动生成的JSDoc文档文件,但似乎无法找到输出文档的方法。 是否可以输出文件到JSON或HTML?或者我将不得不使用RegExp构建我自己的JSDoc分析器? 我已经看遍了整个网络,并找不到任何关于这个问题。 谢谢。

    3热度

    2回答

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

    0热度

    1回答

    我有一段代码,它返回什么有用: /** * Close the web server * * @param {function} callback - Called after web server is stopped */ PolyApp.prototype.stop = function(callback) { if (!this._listeningServer) {

    2热度

    1回答

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

    3热度

    1回答

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

    2热度

    1回答

    如何记录类中的属性名称空间? /** * @constructor User * @param forename * @param surname */ function User(forename, surname) { /** * How to document such a property-namespace? */ this.name

    3热度

    1回答

    我写的一些功能,像这样: /** * Throw TypeError when val is invalid * @param {JOIN_TYPES} type * @param {Class|Function} cls * @param {*} val * @param {Object} options * @param {String} options.wrongJoinType

    1热度

    1回答

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