1

JavaScript では、次のようなことが非常に一般的です。

function A (options, aaa, bbb) {
  var ccc = options.ccc;
  var ddd = options.ddd;
}

そして現在、私はそれを次のようにコメントしています：

/**
 * a completely useless function
 *
 * @param {Object} options where options.ccc is {Number} ccc and options.ddd is {String} ddd
 * @param {Boolean} aaa
 * @param {String} bbb
 */

options パラメーターの属性の記述方法に不満があります

それらを「{Type} description」パターンに入れるきれいな方法はありますか?

4

1 に答える 1

0

私は通常、変数名の後、説明の前にタブを 1 つか 2 つ置きます。同意しますが... 私も大ファンではありません。しかし、これは jsdocs がそれを処理する方法です。フォーマットをいじりすぎると、適切なドキュメントが解析されない場合があります。

/**
 * SLP.Modules.Codes extends the SLP.Modules object on DOM-ready.
 * @module Codes
 */
SLP.Modules.Codes = {
    /**
     * First validate for empty fields, then check the campaign codes,
     * making sure that they begin with T(oyota), L(exus), or S(cion).
     * @param  {object} event   jQuery Event object (form submit)
     * @return {boolean}        true if all validation passes.
     */
    validateCampaignCodes: function(event){
        var $input, isValid = SLP.validateFormInputsNotEmpty(event);
        if (isValid) {// Continue validation if all fields are non-empty.
            $input = $("input").filter("[name=campaign_code]").each(function(){
                if (!(isValid = /^[TLS]/i.test(this.value))) {
                    return !SLP.DOM.$modalPrompt.find(".modal-body").html( // Error msg.
                        "Campaign Codes must begin with T(oyota), S(cion), or L(exus)."
                    ).end().modal("show");// On error, immediately exit (the each method).
                }
            });
        }
        // Convert campaign codes to uppercase for submission.
        $input.val(function(i,v){ return v.toUpperCase(); });
        // Enable all checkboxes to submit values with form.
        $("input[type=checkbox]").attr("disabled", false);
        return isValid;
    },
于 2012-08-03T00:19:07.057 に答える