2013-03-19 32 views
16

Kısa bir süre önce javascript kodumuzu belgelemek için jsdoc yorumlarını kullanmaya başladım, ancak @param etiketinin kullanımıyla ilgili çelişen örnekler buluyorum.jsDoc yorumları için kullanılacak doğru kasa nedir?

bakınız https://code.google.com/p/jsdoc-toolkit/wiki/TagParam (PascalCase)

ve https://developers.google.com/closure/compiler/docs/js-for-compiler (deve/küçük).

var foo = 1; 
console.log(typeof foo); // outputs "number" 

jsDoc @param yorumlar için kullanılacak doğru kasa nedir:

camelCase beri bana mantıklı? Yoksa önemi yok mu? Belge oluşturma için kullanmayı ve yazım denetimi için google kapatma yoluyla kodu çalıştırmayı planlıyorum.

Teşekkürler! String, Number ve Boolean: JSDoc tipi ifadeleri

cevap

16

çakışan örnekleri, ilgili sarma türleri JavaScript ilkel türde string, number ve boolean, içerir. Closure: The Definitive Guide kaynaktan

: sargı tipleri ilkel türleri beklenmektedir kullanıldığında bazı fonksiyonlar doğru çalışmayabilir olarak

sargı tiplerinin kullanılması, Closure Library yasaktır.

bakınız MDN: Distinction between string primitives and String objects.

+3

Çoğu durumda, Nesne türü yerine ilkel türünü istiyorsunuz. Derleyici, gerektiğinde ilkel türünü otomatik olarak (teşvik eder), ancak tersi doğru olmaz. –

+0

Teşekkürler cpeisert! Kesinlikle kitabı almalıyım! – magritte

+0

kesinlikle yapar. Sadece kapanış bilgisi için değil, harika bir okuma! – jordancpaul

İlgili konular