代码之家 › 专栏 › 技术社区 › CryptoBird

此文档是否正确?(是/否回答对我来说就足够了)

jsdoc3 jsdoc javascript

1

CryptoBird · 技术社区 · 7 年前

我真的很困惑如何记录这三种方法(onKick、offKick、triggerchick):

var events = $( {} ); // jQuery Pub/Sub .

/**
 * Creates a football player .
 * @constructor
 */
function Player() {
 ...
}

Player.prototype = {
    ...,
    /**
     * Subscribes a function to the kick event .
     * @param  {Function} fn An event handler .
     */
    onKick: function( fn ) {
        events.on('kick.FootballGame', fn);
    },

    /**
     * Unsubscribes a function from the kick event .
     * @param  {Function} fn The event handler .
     */
    offKick: function( fn ) {
        events.off('kick.FootballGame', fn);
    },

    /**
     * Kicks the ball .
     * @fires kick.FootballGame
     */
    triggerKick: function() {
        events.trigger('kick.FootballGame');
    },
    ...
};

此文档是否正确?是/否回答将不胜感激。

谢谢

1 回复 | 直到 7 年前

1

0

SaschaM78 Maxx 7 年前

我要说的是,您已经接近了一个记录良好的脚本块。我将提出一些修改,如您的代码所示:

/**
 * Creates an new Football Player.
 * @constructor
 */
function Player() {
 ...
}

Player.prototype = {

    /**
     * Subscribes a function to the kick event.
     * @param {function} fn - an event handler.
     */
    onKick: function( fn ) {
        events.on('kick.FootballGame', fn);
    },

    ...
};

一般规则:

一行中最后一个单词和点之间没有空格
单词之间不超过一个空格
用破折号分隔参数及其用途
遵循变量类型的情况(如适用),即。 {function} 而不是 {Function}