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
Ö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ş:
Nasıl "düzgün" JavaScript öz...
Nasıl "bu" JavaScript bir ne...
Nasıl "bağımsız" dönüştürme; ...
Nasıl "nesne" dönmek; C ?...
&Quot;bağımsız değişkenler geçirmeden ...