JSDoc ezali générateur ya mikanda ya makasi mpo na JavaScript. Esalelaka ba commentaires formatés spécialement pona kosala documentation ya API ya détail pona code na yo. Na kobakisa ba commentaires ya JSDoc na ba fichiers JavaScript na yo, okoki kopesa ba informations ya polele pe ya structured na oyo etali ba fonctions, ba classes, pe ba modules na yo.
Makambo ya ntina ya JSDoc:
Tyá makambo oyo etali yo
Ba paramètres ya fonction na ba valeurs ya retour
Bandimbola ya kelasi mpe ya mayele
Mikanda ya module
Tag moko ya tina mingi na JSDoc ezali tag @example. Tag oyo epesi yo nzela ya kokotisa bandakisa ya code na mikanda na yo. Oyo ekesenisaka esaleli na biso ezali makoki na yango ya kobatela formatage, indentation, mpe bopanzani ya milɔngɔ na kati ya balimboli @example. Yango elingi koloba ete okoki kokoma bandakisa ya code oyo ekoki kotangama mingi mpe ya solo, kosala ete ezala pete mpo na ba développeurs ba comprendre ndenge ya kosalela ba fonctions to ba classes na yo.
Ndakisa ya bosaleli:
/**
* 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;
}
Na kosaleláká générateur na biso ya ba commentaires JSDoc en ligne, okoki kosala na pete mikanda oyo ebongisami malamu oyo ezali na formatage oyo ebatelami na bandakisa ya code na yo, kosala ete mikanda na yo ya JavaScript ezala polele mpe ezala malamu.