JSDoc ke jenereithara e matla ya ditokomane bakeng sa JavaScript. E šomiša ditshwayotshwayo tše di rulagantšwego ka mo go kgethegilego go hlama ditokomane tša API tše di tletšego tša khoutu ya gago. Ka go oketša ditshwayotshwayo tša JSDoc go difaele tša gago tša JavaScript, o ka fa tshedimošo ye e kwagalago le ye e rulagantšwego ka ga mešomo ya gago, diklase, le dimmojule.
Dikarolo tše bohlokwa tša JSDoc:
Thaepa tshedimošo
Mosebetsi ditekanyetos le khutlela boleng
Ditlhaloso tša sehlopha le mokgwa
Ditokomane tša modula
Tagi ye tee ye e nago le mohola kudu ka go JSDoc ke thepo ya @example. Thepo ye e go dumelela go akaretša mehlala ya khoutu ka gare ga ditokomane tša gago. Seo se hlaolago sedirišwa sa rena ke bokgoni bja sona bja go boloka go fometa, go tsenya, le go kgaotša mela ka gare ga thepo ya @example. Se se ra gore o ka ngwala mehlala ya khoutu ye e balegago kudu le ya kgonthe, go dira gore go be bonolo go bahlami go kwešiša ka moo ba ka šomišago mešomo ya gago goba diklase.
Tšhomišo ya mohlala: .
/**
* Calculates the sum of two numbers.
* @param {number} a - The first number.
* @param {number} b - The second number.
* @returns {number} The sum of a and b.
* @example
* // This example preserves formatting and line breaks
* const result = add(5, 3);
* console.log(result);
* // Output: 8
*/
function add(a, b) {
return a + b;
}
Ka go šomiša jenereithara ya rena ya ditshwayotshwayo ya JSDoc ya inthaneteng, o ka hlama gabonolo ditokomane tše di fometetšwego gabotse tšeo di akaretšago go fometa mo go bolokilwego mehlaleng ya gago ya khoutu, go dira gore ditokomane tša gago tša JavaScript di be molaleng kudu le go šoma gabotse.