resmi JSDoc örneklerin tümü aşağıdaki gibi safça basit belgeler dizeleri vardır:Uzun JSDoc çizgilerinin doğru/kanonik formatlaması nedir?
/**
* @param {string} author - The author of the book, presumably some person who writes well
*/
Ama tarihi:
/**
* @param {string} author - The author of the book.
*/
, gerçek yaşam belgelerinde sık sık uzun dokümantasyon dizeleri var olan sorun Çoğu şirket (meşru okunabilirlik nedenleriyle) satır uzunluğu sınırlarına sahiptir, yukarıdakiler genellikle kabul edilebilir değildir. Ancak, anlayamadığım şey, bu çizgileri kırmanın "doğru" yolunun ne olması gerektiğidir.
/**
* @param {string} author - The author of the book, presumably some
* person who writes well
*/
Ama bu okumak zordur:
yapabilirdim. Bunun yerine yapabileceğini:
/**
* @param {string} author - The author of the book, presumably some
* person who writes well
*/
parametre uzun adı olan, özellikle çizgilerin bir ton daha iyi görünüyor, ama neden olabilir:
Yani benim sorudur/**
* @param {string} personWhoIsTheAuthorOfTheBook - The author of the
* book, presumably
* some person who
* writes well
*/
, ne doğru/resmi/kurallı biçimlendirme uzun @param satırları (kodda, oluşturulan JSDoc değil) ... veya gerçekten bu konu için herhangi bir uzun açıklama satırları.