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
Ç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. –
Teşekkürler cpeisert! Kesinlikle kitabı almalıyım! – magritte
kesinlikle yapar. Sadece kapanış bilgisi için değil, harika bir okuma! – jordancpaul