请看下面的代码。所以我有一个对象,我想用jsdoc来记录它的属性,所以我使用jsdoc的来记录这个myObject对象的那些属性。但是,我也想记录更复杂的信息,比如一些代码示例,而不仅仅是简单的名称、类型和描述。
但是在中,他们说我们只能添加那些简单的名字或描述信息,而不能添加更复杂的东西(他们说:“它不允许你提供@示例或类似的复杂信息.”)。
/**
* An object with some simple properties
* @type {Object}
* @property {String} firstProperty This is the first property
如何在JSDoc3中正确地记录这些代码?
var Foo,
doFoo;
/**
* What JSDoc string should go here ...
*/
doFoo = function () {};
/**
* @constructor
*/
Foo = function () {};
/**
* ... and here ..
*/
Foo.doFoo = doFoo;
/**
* ... and here ..
*/
Foo.prototype.doBar = doFoo;
/**
* ... and here?
*/
Foo.proto
我试图用jsdoc-工具箱记录特定模块模式中的函数,其中命名空间是在模块之外定义的。附加到它的函数在立即调用函数中。我从工具输出中得到的是:
警告:试图将isObject记录为无文档符号核心的成员。
下面是代码的简化版本:
/**
* @namespace The framework's top namespace
* */
var FX = {
/**
* @namespace The core framework functions
*/
core: {
}
};
(function( CORE, GLOBAL ) {
'use st
我一直在尝试使用JSDoc来记录以下代码:
/**
* @module person
*/
/**
* A human being.
* @class
* @param {string} name
*/
function Person(name){
this.name = name
}
Person.prototype = new function(){
var amount_of_limbs = 4;
/**
* Introduce yourself
*/
this.greet = function(){
所以我试图用jsdoc为我的代码中的一行生成一个简单的文档,但是jsdoc忽略了它,因为我没有声明任何东西。有没有办法强制它呢?这就是我想要做的:
/**
* Just trying to doc something like this
*/
JSONLogic.add_operation('sqrt', Math.sqrt);
我试图添加一个@todo标签,但它也不起作用。
我们正在考虑在公司内采用来保持跨项目的一致性,但有一件事让我感到困惑。在关于的一节中,它说要使用@const关键字注释来执行编译时不变的操作,但我以前从未遇到过@符号。这是Google的扩展,还是核心语言的一部分?
全文如下:
对于非原语,请使用@const注释。
/**
* The number of seconds in each of the given units.
* @type {Object.<number>}
* @const
*/
goog.example.SECONDS_TABLE = {
minute: 60,
hour: 6
我想使用带有一些@example的JSDoc来记录javascript函数,但是它破坏了JSDoc。 我想要的代码示例如下所示(我想要的版本): stripJSDoc(`/**
* Hello
*/
function Hello();
/**
* World
*/
function World();`)
// => ['Hello', 'World'] 我将在下面插入上面的内容。 /**
* Strip JSDoc text from given string.
*
* @example
*
* // I will insert abo
下面代码的JSDoc总是给出错误
错误: JSDoc描述不符合regex模式
在类型记录(使用)中生成Visual代码中的动态注释。
我们遵循JsDoc标准来注释和记录所有代码。
/**
* Validates if entityName is present in the Json Schema
* @param {any} obj Contains the object from the Json Schema
* @param {number} idx It contains the index of the object
* @
在JSDOC中记录属性默认值时,我找不到打印空间的方法。示例:/** * @prop {string} str='String with space' - The string. */
这将被记录为:
Name Type Default Description
str string 'String with space' - The string
有什么建议怎么做正确的吗?
在V8中,对象在添加新属性时更改其。
function Point(x, y) {
this.x = x; // This will create new hidden class
this.y = y; // This too
}
我的问题很简单,这会产生一个新的隐藏类吗?
Point.prototype.z = null;
我问这个问题是因为在我读过的编码风格指南中,他们说我们应该通过创建一个原型来声明类属性,而不是在构造函数中分配它们。这也将帮助我们轻松地用JSDoc记录它们。
非常感谢。