SORU
23 HAZİRAN 2011, PERŞEMBE


Nasıl tarif "nesne" jsdoc bağımsız değişkenler?

// My function does X and Y.
// @params {object} parameters An object containing the parameters
// @params {function} callback The callback function
function(parameters, callback) {
}

Ama nasıl parametreleri nesne yapılandırılmalıdır nasıl tarif ederim? Örneğin gibi bir şey olmalıdır:

{
  setting1 : 123, // (required, integer)
  setting2 : 'asdf' // (optional, string)
}

CEVAP
23 HAZİRAN 2011, PERŞEMBE


@param wiki page:


Özellikleri İle Parametreler

Eğer bir parametre belirli bir mal olması beklenen ise, hemen o yüzden böyle parametresi için @param etiketinden sonra belge:

 /**
  * @param userInfo Information about the user.
  * @param userInfo.name The name of the user.
  * @param userInfo.email The email of the user.
  */
 function logIn(userInfo) {
        doLogIn(userInfo.name, userInfo.email);
 }

Hemen ilgili @param takip @config etiketi vardı, ama (example here) kaldırılmıştır görünüyor.

Bunu Paylaş:
  • Google+
  • E-Posta
Etiketler:

YORUMLAR

SPONSOR VİDEO

Rastgele Yazarlar

  • Caroline Saquet

    Caroline Saq

    1 EKİM 2011
  • Pepsi

    Pepsi

    1 Kasım 2005
  • Slave Boy Films - Fandom from a Galaxy Far Far Away

    Slave Boy Fi

    12 HAZİRAN 2009