这个文件是否正确？（是/否答案对我来说已经足够）

Question

我真的很困惑，我应该如何记录这三种方法（onKick，offKick，triggerKick）：

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');
    },
    ...
};

此文档是否正确？是/否答案真的很感激。

谢谢。

Answer 1

我说你接近一个记录良好的脚本块。我会提出一些更改，在您的代码中说明：

/**
 * 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}