JSDoc
ಜೆಎಸ್ ಡಾಕ್ ಎಂಬುದು ಜಾವಾಸ್ಕ್ರಿಪ್ಟ್ ಮೂಲ ಕೋಡ್ ಫೈಲ್ಗಳನ್ನು ಟಿಪ್ಪಣಿ ಮಾಡಲು ಬಳಸುವ ಮಾರ್ಕ್ಅಪ್ ಭಾಷೆಯಾಗಿದೆ. ಜೆಎಸ್ಡಾಕ್ ಹೊಂದಿರುವ ಕಾಮೆಂಟ್ಗಳನ್ನು ಬಳಸಿಕೊಂಡು, ಪ್ರೋಗ್ರಾಮರ್ಗಳು ತಾವು ರಚಿಸುತ್ತಿರುವ ಕೋಡ್ನ ಅಪ್ಲಿಕೇಶನ್ ಪ್ರೋಗ್ರಾಮಿಂಗ್ ಇಂಟರ್ಫೇಸ್ ಅನ್ನು ವಿವರಿಸುವ ದಾಖಲೆಯನ್ನು ಸೇರಿಸಬಹುದು. ಎಚ್. ಟಿ. ಎಂ. ಎಲ್ ಮತ್ತು ರಿಚ್ ಟೆಕ್ಸ್ಟ್ ಫಾರ್ಮ್ಯಾಟ್ನಂತಹ ಪ್ರವೇಶಿಸಬಹುದಾದ ಸ್ವರೂಪಗಳಲ್ಲಿ ದಾಖಲಾತಿಗಳನ್ನು ತಯಾರಿಸಲು ಇದನ್ನು ವಿವಿಧ ಸಾಧನಗಳ ಮೂಲಕ ಸಂಸ್ಕರಿಸಲಾಗುತ್ತದೆ. ಜೆಎಸ್ ಡಾಕ್ ವಿವರಣೆಯನ್ನು ಸಿಸಿ ಬಿವೈ-ಎಸ್ಎ 3 ಅಡಿಯಲ್ಲಿ ಬಿಡುಗಡೆ ಮಾಡಲಾಗಿದ್ದು, ಅದರ ಸಹವರ್ತಿ ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಜನರೇಟರ್ ಮತ್ತು ಪಾರ್ಸರ್ ಲೈಬ್ರರಿಯು ಅಪಾಚೆ ಲೈಸೆನ್ಸ್ 2 ಅಡಿಯಲ್ಲಿ ಉಚಿತ ಸಾಫ್ಟ್ವೇರ್ ಆಗಿದೆ. ಹಿಸ್ಟರಿ ಜೆಎಸ್ಡಾಕ್ನ ವಾಕ್ಯರಚನೆ ಮತ್ತು ಶಬ್ದಾರ್ಥವು ಜಾವಡಾಕ್ ಯೋಜನೆಯನ್ನು ಹೋಲುತ್ತದೆ, ಇದನ್ನು ಜಾವಾದಲ್ಲಿ ಬರೆಯಲಾದ ಕೋಡ್ ಅನ್ನು ದಾಖಲಿಸಲು ಬಳಸಲಾಗುತ್ತದೆ. ಜೆಎಸ್ಡಾಕ್ ಜಾವಡಾಕ್ಗಿಂತ ಭಿನ್ನವಾಗಿದೆ, ಏಕೆಂದರೆ ಇದು ಜಾವಾಸ್ಕ್ರಿಪ್ಟ್ನ ಕ್ರಿಯಾತ್ಮಕ ನಡವಳಿಕೆಯನ್ನು ನಿರ್ವಹಿಸುವಲ್ಲಿ ಪರಿಣತಿ ಹೊಂದಿದೆ. ಜಾವಾಸ್ಕ್ರಿಪ್ಟ್ ಅನ್ನು ದಾಖಲಿಸಲು ಜಾವಡಾಕ್ ತರಹದ ವಾಕ್ಯರಚನೆಯನ್ನು ಬಳಸುವ ಆರಂಭಿಕ ಉದಾಹರಣೆಯನ್ನು 1999 ರಲ್ಲಿ ಜಾವಾದಲ್ಲಿ ಬರೆಯಲಾದ ಜಾವಾಸ್ಕ್ರಿಪ್ಟ್ ರನ್-ಟೈಮ್ ಸಿಸ್ಟಮ್ ಆದ ನೆಟ್ಸ್ಕೇಪ್/ಮೊಜಿಲ್ಲಾ ಪ್ರಾಜೆಕ್ಟ್ ರೈನೋದೊಂದಿಗೆ ಬಿಡುಗಡೆ ಮಾಡಲಾಯಿತು. ಇದು ಅದರ ಜಾವಾಸ್ಕ್ರಿಪ್ಟ್ ಸಾಮರ್ಥ್ಯಗಳಿಗೆ ಉದಾಹರಣೆಯಾಗಿ 1.3ರವರೆಗಿನ ಆವೃತ್ತಿಯ ಆಟಿಕೆ "ಜೆ. ಎಸ್. ಡಿ. ಓ. ಸಿ". ಎಚ್. ಟಿ. ಎಂ. ಎಲ್ ಜನರೇಟರ್ ಅನ್ನು ಒಳಗೊಂಡಿತ್ತು. "ಜೆ. ಎಸ್. ಡಿ. ಓ. ಸಿ". ನ ಎಲ್ಲಾ ಪ್ರಮುಖ ತಲೆಮಾರುಗಳ ನೇತೃತ್ವವನ್ನು ಮೈಕ್ ಮ್ಯಾಥ್ಯೂಸ್ (ಮೈಕೆಲ್ ಮ್ಯಾಥ್ಯೂಸ್) ವಹಿಸಿದ್ದರು. ಅವರು 2001 ರಲ್ಲಿ ಕೆನಡಾದ ಪ್ರೋಗ್ರಾಮರ್ ಗ್ಯಾಬ್ರಿಯಲ್ ರೀಡ್ ಅವರ ಸಹಕಾರದೊಂದಿಗೆ ಪರ್ಲ್ನಲ್ಲಿ ಬರೆಯಲಾದ ಸರಳ ವ್ಯವಸ್ಥೆಯಾದ JSDoc.pm ನೊಂದಿಗೆ ಪ್ರಾರಂಭಿಸಿದರು. ಇದನ್ನು ಸೋರ್ಸ್ಫೋರ್ಜ್ ನಲ್ಲಿ ಸಿ. ವಿ. ಎಸ್. ಭಂಡಾರದಲ್ಲಿ ಪ್ರಸಾರ ಮಾಡಲಾಯಿತು. ಜೆ. ಎಸ್. ಡಿ. ಓ. ಸಿ. 1ರಿಂದ (2007) ಅವರು ಈ ವ್ಯವಸ್ಥೆಯನ್ನು ಜಾವಾಸ್ಕ್ರಿಪ್ಟ್ನಲ್ಲಿ (ಮತ್ತೆ ರೈನೋ) ಪುನಃ ಬರೆದರು, ಮತ್ತು ವಿಸ್ತರಣೆಗಳ ಒಂದು ಗುಂಪಿನ ನಂತರ ಜೆ. ಎಸ್. ಡಿ. ಓ. ಸಿ. 2 (2008) "ಜೆ. ಎಸ್. ಡಿ. ಓ. ಸಿ.-ಟೂಲ್ಕಿಟ್" ಎಂಬ ಹೆಸರನ್ನು ಪಡೆದುಕೊಂಡಿತು. ಎಮ್ಐಟಿ ಪರವಾನಗಿ ಅಡಿಯಲ್ಲಿ ಬಿಡುಗಡೆಯಾದ ಇದನ್ನು ಗೂಗಲ್ ಕೋಡ್ನಲ್ಲಿರುವ ಸಬ್ವರ್ಷನ್ ರೆಪೊಸಿಟರಿ ಯಲ್ಲಿ ಹೋಸ್ಟ್ ಮಾಡಲಾಗಿದೆ. 2011 ರ ಹೊತ್ತಿಗೆ ಅವರು ಈ ವ್ಯವಸ್ಥೆಯನ್ನು ಜೆಎಸ್ ಡಾಕ್ 3 ಗೆ ಮರುರೂಪಿಸಿದ್ದಾರೆ ಮತ್ತು ಫಲಿತಾಂಶವನ್ನು ಗಿಟ್ಹಬ್ನಲ್ಲಿ ಹೋಸ್ಟ್ ಮಾಡಿದ್ದಾರೆ. ಇದು ಈಗ Node.js ನಲ್ಲಿ ಕಾರ್ಯನಿರ್ವಹಿಸುತ್ತದೆ. ಜೆಎಸ್ ಡಾಕ್ ಟ್ಯಾಗ್ಗಳು ಆಧುನಿಕ ಜೆಎಸ್ ಡಾಕ್ನಲ್ಲಿ ಬಳಸಲಾಗುವ ಕೆಲವು ಹೆಚ್ಚು ಜನಪ್ರಿಯ ಟಿಪ್ಪಣಿ ಟ್ಯಾಗ್ಗಳೆಂದರೆಃ {| ಕ್ಲಾಸ್ = "ವಿಕಿಟೇಬಲ್"! ಟ್ಯಾಗ್! ! ವಿವರಣೆ |-| @author | | ಡೆವಲಪರ್ ಹೆಸರು |-| @constructor | ಒಂದು ಫಂಕ್ಷನ್ ಅನ್ನು ಕನ್ಸ್ಟ್ರಕ್ಟರ್ ಎಂದು ಗುರುತಿಸುತ್ತದೆ |-| @deprecated | ಒಂದು ವಿಧಾನವನ್ನು ಅಸಮ್ಮತಿ ಎಂದು ಗುರುತಿಸುತ್ತದೆ |-| @exception | | @throws |-| @exports | | ಮಾಡ್ಯೂಲ್ನಿಂದ ರಫ್ತು ಮಾಡಲಾದ ಸದಸ್ಯರನ್ನು ಗುರುತಿಸುತ್ತದೆ |-| @param | | ವಿಧಾನದ ನಿಯತಾಂಕವನ್ನು ದಾಖಲಿಸುತ್ತದೆ; ಸುರುಳಿಯಾಕಾರದ ಕಟ್ಟುಪಟ್ಟಿಗಳ ನಡುವೆ ಡೇಟಾಟೈಪ್ ಸೂಚಕವನ್ನು ಸೇರಿಸಬಹುದು |-| @private | ಸದಸ್ಯರು ಖಾಸಗಿ ಎಂದು ಸೂಚಿಸುತ್ತದೆ |-| @returns | ಡಾಕ್ಯುಮೆಂಟ್ಗಳು ರಿಟರ್ನ್ ಮೌಲ್ಯ |-| @return | ಸಮಾನಾರ್ಥಕ |-| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | */ವರ್ಗ ವೃತ್ತವು ವೃತ್ತದ ಒಂದು ಉದಾಹರಣೆಯನ್ನು ರಚಿಸುತ್ತದೆ. * * @author: ಮೋಯಿ * @param {ಸಂಖ್ಯೆ} r ವೃತ್ತದ ಅಪೇಕ್ಷಿತ ತ್ರಿಜ್ಯ. */ಕನ್ಸ್ಟ್ರಕ್ಟರ್ (r) {/* * @private */this.radius = r/* @private */this.circumference = 2 * Math.PI * r}/* * * ವ್ಯಾಸದಿಂದ ಹೊಸ ವೃತ್ತವನ್ನು ರಚಿಸುತ್ತದೆ. * * @param {ಸಂಖ್ಯೆ} d ವೃತ್ತದ ಬಯಸಿದ ವ್ಯಾಸ. * @return {ವೃತ್ತ} ಹೊಸ ವೃತ್ತದ ವಸ್ತು. */ವ್ಯಾಸದಿಂದ ಸ್ಥಿರ (ಡಿ) {ಹೊಸ ವೃತ್ತವನ್ನು ಹಿಂತಿರುಗಿಸಿ (ಡಿ/2)}/* * * ವೃತ್ತದ ಸುತ್ತಳತೆಯನ್ನು ಲೆಕ್ಕಾಚಾರ ಮಾಡುತ್ತದೆ. * * @deprecated 1.1.0 ರಿಂದ; ವೃತ್ತದ ಸುತ್ತಳತೆಯ ಬದಲಿಗೆ * @return {ಸಂಖ್ಯೆ} ಅನ್ನು ಬಳಸಿ. */ಕ್ಯಾಲಿಕ್ಯುಲೇಟ್ ಸರ್ಕಮ್ಫೆರೆನ್ಸ್ () {ರಿಟರ್ನ್ 2 * Math.PI * this.radius}/* * * ವೃತ್ತದ ಪೂರ್ವ-ಗಣಿತ ಸುತ್ತಳತೆಯನ್ನು ಹಿಂತಿರುಗಿಸುತ್ತದೆ. * * @return {ಸಂಖ್ಯೆ} ವೃತ್ತದ ಸುತ್ತಳತೆ. * @since 1.1.0 */ಗೆಟ್ ಸರ್ಕಮ್ಫೆರೆನ್ಸ್ () {ರಿಟರ್ನ್ this.circumference}/* * * ವೃತ್ತದ ಸ್ಟ್ರಿಂಗ್ ಪ್ರಾತಿನಿಧ್ಯವನ್ನು ಹುಡುಕಿ. * * @override * @return {ಸ್ಟ್ರಿಂಗ್} ಈ ವೃತ್ತದ ಮಾನವ-ಓದಬಲ್ಲ ಪ್ರಾತಿನಿಧ್ಯ. */ಗೆ ಸ್ಟ್ರಿಂಗ್ () {ರಿಟರ್ನ್ '[${this.radius} ತ್ರಿಜ್ಯವನ್ನು ಹೊಂದಿರುವ ವೃತ್ತದ ವಸ್ತು. ] '}}/* * * ವೃತ್ತವನ್ನು ಮುದ್ರಿಸುತ್ತದೆ. * * @param {ವೃತ್ತ} ವೃತ್ತ */ಕಾರ್ಯ ಮುದ್ರಣ ವೃತ್ತ (ವೃತ್ತ) {/* * @this {ವೃತ್ತ) */ಕಾರ್ಯ ಬದ್ಧ () {console.log (ಇದು)} bound.apply (ವೃತ್ತ)} ಟ್ಯಾಗ್ಗಳು ಮತ್ತು ಟ್ಯಾಗ್ಗಳನ್ನು ವಾಸ್ತವವಾಗಿ ಬಿಟ್ಟುಬಿಡಬಹುದು ಎಂಬುದನ್ನು ಗಮನಿಸಿಃ ಅವುಗಳ ಗುರುತುಗಳನ್ನು ಸ್ಪಷ್ಟಪಡಿಸಲು ಇಸಿಎಂಎಸಿಂಟ್ಯಾಕ್ಸ್ ಸಾಕಾಗುತ್ತದೆ, ಮತ್ತು ಜೆಎಸ್ಡಿಒಸಿ ಅದನ್ನು ಬಳಸುತ್ತದೆ. ಇದನ್ನು ಸ್ವಯಂಚಾಲಿತವಾಗಿಯೂ ಊಹಿಸಬಹುದು. ಗೂಗಲ್ನ ಕ್ಲೋಸರ್ ಲಿಂಟರ್ ಮತ್ತು ಕ್ಲೋಸರ್ ಕಂಪೈಲರ್ ಅನ್ನು ಜೆಎಸ್ ಡಾಕ್ ಬಳಸುತ್ತಿದೆ. ಎರಡನೆಯದು ಅದರ ಔಟ್ಪುಟ್ ಜಾವಾಸ್ಕ್ರಿಪ್ಟ್ ಅನ್ನು ಅತ್ಯುತ್ತಮವಾಗಿಸಲು ಪ್ರಕಾರದ ಮಾಹಿತಿಯನ್ನು ಹೊರತೆಗೆಯುತ್ತದೆ. ಟೈಪ್ಸ್ಕ್ರಿಪ್ಟ್ ಜೆ. ಎಸ್. ಡಿ. ಓ. ಸಿ ಪ್ರಕಾರದ ಟಿಪ್ಪಣಿಗಳೊಂದಿಗೆ ಜಾವಾಸ್ಕ್ರಿಪ್ಟ್ ಕಡತಗಳಿಗೆ ಟೈಪ್ ಚೆಕಿಂಗ್ ಅನ್ನು ಮಾಡಬಹುದು. ಮೈಕ್ರೋಸಾಫ್ಟ್ ವಿಸ್ತರಿಸಬಹುದಾದ ಟ್ಯಾಗ್ಗಳೊಂದಿಗೆ ಹೊಸ ಟಿಎಸ್ಡಾಕ್ ಭಾಷೆಯನ್ನು ನಿರ್ದಿಷ್ಟಪಡಿಸಿದೆ. ಜನಪ್ರಿಯ ಸಂಪಾದಕ ಸಬ್ಲೈಮ್ ಟೆಕ್ಸ್ಟ್ ಡಾಕ್ಬ್ಲಾಕ್ಆರ್ ಅಥವಾ ಡಾಕ್ಸಿಡಾಕ್ಸಿಜೆನ್ ಪ್ಲಗ್ಇನ್ ಮೂಲಕ ಜೆಎಸ್ಡಾಕ್ ಅನ್ನು ಬೆಂಬಲಿಸುತ್ತದೆ ಜೆಎಸ್ಡಾಕ್ ವಾಕ್ಯರಚನೆಯನ್ನು ಅಪ್ರೆಸ್ ಪುಸ್ತಕ ಫೌಂಡೇಶನ್ಸ್ ಆಫ್ ಅಜಾಕ್ಸ್ನಲ್ಲಿ ಸುದೀರ್ಘವಾಗಿ ವಿವರಿಸಲಾಗಿದೆ. ಇಂಟೆಲಿಜೆ ಐಡಿಯಾ, ನೆಟ್ಬೀನ್ಸ್, ವಿಷುಯಲ್ ಸ್ಟುಡಿಯೋ ಕೋಡ್ ಮತ್ತು ರೂಬಿಮೈನ್ ಜೆಎಸ್ಡಾಕ್ ವಾಕ್ಯರಚನೆಯನ್ನು ಅರ್ಥಮಾಡಿಕೊಳ್ಳುತ್ತವೆ. ಎಕ್ಲಿಪ್ಸ್-ಆಧಾರಿತ ಆಪ್ಟಾನಾ ಸ್ಟುಡಿಯೋ ಸ್ಕ್ರಿಪ್ಟ್ ಡಾಕ್ ಅನ್ನು ಬೆಂಬಲಿಸುತ್ತದೆ. ಮೊಜೈಲ್, ಮೊಜಿಲ್ಲಾ ಇನ್ಲೈನ್ ಎಡಿಟರ್ JSDoc.pm ಅನ್ನು ಬಳಸುತ್ತದೆ. ಹೆಲ್ಮಾ ಅಪ್ಲಿಕೇಶನ್ ಚೌಕಟ್ಟು ಜೆ. ಎಸ್. ಡಿ. ಓ. ಸಿ. ಅನ್ನು ಬಳಸುತ್ತದೆ. ಜೆ. ಎಸ್. ಡಿ. ಓ. ಸಿ. ಬಳಸಿ ಸ್ಪ್ರಾಉಟ್ಕೋರ್ ದಾಖಲೆಯನ್ನು ರಚಿಸಲಾಗಿದೆ. ವಿಷುಯಲ್ ಸ್ಟುಡಿಯೋ, ವೆಬ್ಸ್ಟಾರ್ಮ್ ಮತ್ತು ಇತರ ಅನೇಕ ಸಮಗ್ರ ಅಭಿವೃದ್ಧಿ ಪರಿಸರಗಳು ಅಥವಾ ಪಠ್ಯ ಸಂಪಾದಕರು ಜೆಎಸ್ಡಾಕ್ ಕಾಮೆಂಟ್ಗಳ ಆಧಾರದ ಮೇಲೆ ಕೋಡ್ ಕಂಪ್ಲೀಷನ್ ಮತ್ತು ಇತರ ಸಹಾಯವನ್ನು ನೀಡುತ್ತಾರೆ. ಓಪನ್ ಸೋರ್ಸ್ ಆಟಮ್ ಎಡಿಟರ್ ಆಟಮ್-ಈಸಿ-ಜೆಎಸ್ ಡಾಕ್ ಪ್ಲಗ್ಇನ್ ಮೂಲಕ ಜೆಎಸ್ ಡಾಕ್ ಅನ್ನು ಬೆಂಬಲಿಸುತ್ತದೆ. ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಜನರೇಟರ್ಗಳ ಹೋಲಿಕೆ ಗೂಗಲ್ ಕ್ಲೋಸರ್ ಟೂಲ್ಸ್ ಉಲ್ಲೇಖಗಳು ಬಾಹ್ಯ ಕೊಂಡಿಗಳು ಉಚಿತ ಡಾಕ್ಯುಮೆಂಟೇಶನ್ ಜನರೇಟರ್ಗಳ ಜಾವಾಸ್ಕ್ರಿಪ್ಟ್ ಪ್ರೋಗ್ರಾಮಿಂಗ್ ಟೂಲ್ಗಳನ್ನು ಸಹ ನೋಡಿ.