אַדינג מעטאַדאַטאַ צו דיין דאַקיומענטיישאַן
צושטעלן גוט דאַקיומענטיישאַן איז אַ יקערדיק אַרבעט פֿאַר יעדער דעוועלאָפּער. דאָס העלפּס ניט בלויז דיין פּירז צו געשווינד פֿאַרשטיין דיין ריזאַנינג און טאָמער געדאַנק פּראָצעס, אָבער עס אויך העלפּס איר באַקומען פאַסטער אין די קאָד אויב איר צוריקקומען צו עס נאָך אַ פּאָר פון חדשים.
איך האָב דעריבער געדאַנק צו שאַפֿן אַ (דערענדיקט) רשימה פון ספּעציעל טאַגס צו נוצן מיט JSDoc-קאָמענטעס. דאָס זענען די וואָס איך פּערסנאַלי נוצן רובֿ אָפט און וואָס האָבן פּראָווען צו צושטעלן אַ פאַקטיש נוץ.
אַ יקערדיק סטאַרטער
די פאלגענדע קאָד בייַשפּיל ווייזט אַ פּשוט, יקערדיק ביישפּיל וואָס זאָל זיין געוויינט פֿאַר יעדער דאַקיומענטיישאַן. עס אַנאַטייץ די ציל, פּאַראַמעטערס און די צוריקקומען טיפּ.
/**
* Get a sum all terms provided.
*
* @param {...number} terms Array of terms to sum up.
* @returns {number} Sum of terms.
*/
export function sum(...terms: number[]){
return terms.reduce((acc,cv) => acc + cv, 0);
}
בייַשפּיל קאָד אין די דאַקיומענטיישאַן
איר קענען צושטעלן אַ פאַקטיש ינלינע קאָד בייַשפּיל מיט די "@example" קוויטל צו מאַכן זיכער נוצן קאַסעס קלירער. דעם קוויטל קענען אויך זיין געוויינט צו געשווינד ווייַזן מעגלעך ברעג קאַסעס אין אַ פאַקטיש-וועלט סצענאַר.
/**
* Get a sum all terms provided.
*
* @example
* ```ts
* import { sum } from "./source";
* const result = sum(40, 2);
* ```
*/
export function sum(...terms: number[]){
return terms.reduce((acc,cv) => acc + cv, 0);
}
מיטגליד פון וואָס מאָדולע
ניצן די "@memberOf"-קוויטל צו דעפינירן וואָס מאָדולע אָדער פאָטער בייַטעוודיק האָסץ די דאַקיומענטאַד קאָד.
/**
* @memberOf module:source
*/
export function sum(...terms: number[]){
return terms.reduce((acc,cv) => acc + cv, 0);
}
לינק אַנאָטאַציע
איר קענט נוצן די "@see"-קוויטל צוזאַמען מיט די "@לינק"-קוויטל צו צושטעלן אַ ריכטיק פאָרמאַטטעד URL דאַקיומענטיישאַן, אַנשטאָט פון פּאַסטינג עטלעכע URL ס ינלינע פון די הויפּט דאַקיומענטיישאַן.
/**
* @see (@link module:source.sum}
* @see (@link https://www.some-source.com}
*/
export function sum(...terms: number[]){
return terms.reduce((acc,cv) => acc + cv, 0);
}
גענעריק טיפּ דאַקיומענטיישאַן
אויב דיין קאָד ניצט דזשאַנעריק טייפּס, איר קענען נוצן די "@template" קוויטל צו דעפינירן די דזשאַנעריק טיפּ נאָמען. דער נאָמען איז דעמאָלט געניצט אין די פּראָסט "@param"-טאַגס ווי טיפּ רעפֿערענץ.
/**
* @template T
* @param {...T} Array of numbers to sum up.
* @returns {number} Sum of terms.
*/
export function sum(...terms: number[]){
return terms.reduce((acc,cv) => acc + cv, 0);
}
דיפיינינג דער מחבר פון אַ שטיק פון קאָד
אין עטלעכע קאַסעס, עס איז אויך וויכטיק צו אַנאַטייט די מחבר. דעם קענען זיין פשוט אַטשיווד מיט די "@author"-קוויטל. איר קענט נישט בלויז צושטעלן דיין נאָמען, אָבער אויך אַן E- בריוו ווי קאָנטאַקט רעפֿערענץ.
/**
* @author Tom Schönmann <[email protected]>
*/
export function sum(...terms: number[]){
return terms.reduce((acc,cv) => acc + cv, 0);
}
דיפּרישיייטיד קאָד
עס איז ניט פיל צו זאָגן וועגן די "@דעפּריקייטיד" קוויטל, ווייַל עס טוט פּונקט וואָס איר וואָלט דערוואַרטן. דער קוויטל איז אָפט געניצט אין אַפּיס און קענען אויך דערמאָנען די נייַע קאָד.
/**
* @deprecated Use 'add(...)' instead.
* @see {@link module:source/add}
*/
export function sum(...terms: number[]){
return terms.reduce((acc,cv) => acc + cv, 0);
}
ווערסיע
ניצן די "@version" קוויטל צו דאָקומענט אַ ווערסיע פֿאַר די געגעבן קאָד. באַמערקונג אַז דער קוויטל איז נישט רעפעררעד צו די אַפּלאַקיישאַן ווערסיע, אָבער טאַקע זיין אייגענע. אַ ינקראַמאַנט פון דעם ווערסיע מיטל אַז דער ספּעציפיש קאָד איז פארענדערט.
/**
* @version 1.0.0
*/
export function sum(...terms: number[]){
return terms.reduce((acc,cv) => acc + cv, 0);
}
זינט ווען די קאָד איז בנימצא צו נוצן
איר קענט נוצן די "@since" קוויטל צו דאָקומענט פֿון וואָס ווערסיע נומער די פאלגענדע קאָד איז צוגעלייגט צו די עפנטלעך אַפּי. וויכטיק צו טאָן דאָ איז אַז די ווערסיע איצט רעפערס צו די אַפּלאַקיישאַן-פאַרנעם. דעם קאַנטראַסט מיט די "@version"-קוויטל פון פריער, וואָס איז סקאָופּעד צו די ספּעציפיש קאָד בלאָק עס דאָקומענטן.
/**
* @since 2.0.1
*/
export function sum(...terms: number[]){
return terms.reduce((acc,cv) => acc + cv, 0);
}
