Tag: jsdoc

jQuery兼容的JavaScript文档生成器: 我需要select一个文档生成器（类似于java中的jdoc或Ruby中的rdoc）为我的JavaScript项目（用jQuery，下划线和骨干构build）候选人： jsdoc工具包 PDOC 自然文档 docco YUI文档 doctool http://jquery.bassistance.de/docTool/docTool.html 其他？要求应该使用jQuery，下划线和主干。这意味着对象文字方法等我真的很喜欢pdoc，但是它太过于以原型为中心，没有很好的文档logging，而且我不想制作额外的文件（部分？）来使其工作（不确定这一点） docco是不错的，但我想要结构化的输出（如菜单+ class / func结构像jdoc）必须是命令行/制作文件兼容（不是网上的贴图）提示，技巧，教程，成功的故事，build议非常欢迎。为什么不jQuery使用JSDoc？

如何在JSDoc中指定一个对象数组作为参数或返回值？: 在JSDoc中，我可以find最好的文档，如果你有一个特定types的数组（比如一个string数组），可以使用下面的代码： /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here… } 你将如何replace下面的问号指定一个对象数组？ /** * @param {???????} myObjects All of my equally awesome objects */ function blah(myObjects){ //stuff here… }

如何用JSDoc文件CoffeeScript源代码？: 我有一些用CoffeeScript编写的代码，我想用Google Closure Compiler优化生成的JavaScript，所以这些文件需要用JSDoc来logging。我的问题是，我如何文档* .coffee文件生成包含工作JSDoc为闭包编译器的JavaScript？还有一个问题：有没有办法在* .coffee中保留单行注释？

如何在JsDoc中返回void？: 有没有一种特定的方式来声明一个方法或函数在JsDoc中返回void？目前我认为void是默认返回值，其他返回值必须具体提供： /** * @return {Integer} The identifier for … */

使用jsdoc来logging匿名对象和函数的最佳方式: 编辑：这在技术上是一个2部分的问题。我已经select了涵盖这个问题的一般答案，并将其与处理具体问题的答案联系起来。用jsdoc编写匿名对象和函数的最佳方法是什么？ /** * @class {Page} Page Class specification */ var Page = function() { /** * Get a page from the server * @param {PageRequest} pageRequest Info on the page you want to request * @param {function} callback Function executed when page is retrieved */ this.getPage = function(pageRequest, callback) { }; }; PageRequest对象或callback都不存在于代码中。 […]

如何在有限的可能值jsdoc中logging一个stringtypes: 我有一个接受一个string参数的函数。该参数只能有一个定义的可能值。什么是最好的方式来logging相同的？应该shapeType定义为枚举或TypeDef或别的东西？ Shape.prototype.create = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"… this.type = shapeType; }; Shape.prototype.getType = function (shapeType) { // shapeType can be "rect", "circle" or "ellipse"… return this.type; }; 问题的第二部分是在定义shapeType的文件中不知道shapeType的可能值。有几个开发人员可能会添加到shapeType的可能值的多个文件。 PS：我正在使用jsdoc3

JSDoc：返回对象结构: 我怎么能告诉JSDoc有关返回的对象的结构。我find了@return {{field1: type, field2: type, …}} description语法，并试过了： /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a jQuery event wrapping such an * event. * @param {string} [type="page"] * A string representing the type of location that should be […]

如何在JSDoc中指定承诺的parsing和拒绝types？: 我有一些代码返回一个承诺对象，例如使用Q库的NodeJS。 var Q = require('q'); /** * @returns ??? */ function task(err) { return err? Q.reject(new Error('Some error')) : Q.resolve('Some result'); } 如何使用JSDoc文档这样的返回值？

如何轻松创buildGithub友好降价loggingJavaScriptfunction？: 我希望能够在JavaScript源代码中的任何地方使用JSDoc注释（甚至可以在模块中甚至匿名函数中嵌套几层函数）： /** * Used to do some important thing that needs doing that works like xyz. * @param {String} whatever – some string that has some purpose * @param {Function} callback – a function that needs to be run * @returns {Boolean} whether or not something happened */ function something(whatever, callback) { … 并有一些简单的方法来产生漂亮的降价： ##`root.something(whatever,callback)` […]

正确的方式来loggingJSDoc中的开放式参数函数: 假设你有如下的东西： var someFunc = function() { // do something here with arguments } 你如何正确地logging这个函数可以在JSDoc中取任意数量的参数？这是我最好的猜测，但我不确定是否正确。 /** * @param {Mixed} […] Unlimited amount of optional parameters */ var someFunc = function() { // do something here with arguments } 涉及到： PHP的 – 如何处理可变数量的参数