JSDoc
JSDoc என்பது ஜாவாஸ்கிரிப்ட் மூலக் குறியீடு கோப்புகளைக் குறிக்கப் பயன்படுத்தப்படும் ஒரு மார்க்அப் மொழியாகும். JSDoc கொண்ட கருத்துகளைப் பயன்படுத்தி, புரோகிராமர்கள் தாங்கள் உருவாக்கும் குறியீட்டின் பயன்பாட்டு நிரலாக்க இடைமுகத்தை விவரிக்கும் ஆவணங்களைச் சேர்க்கலாம். இது பின்னர் பல்வேறு கருவிகளால் செயலாக்கப்பட்டு, எச். டி. எம். எல் மற்றும் ரிச் டெக்ஸ்ட் ஃபார்மேட் போன்ற அணுகக்கூடிய வடிவங்களில் ஆவணங்களை உருவாக்குகிறது. JSDoc விவரக்குறிப்பு CC BY-SA 3 இன் கீழ் வெளியிடப்பட்டுள்ளது, அதே நேரத்தில் அதன் துணை ஆவண ஜெனரேட்டர் மற்றும் பார்ஸர் நூலகம் அப்பாச்சி உரிமம் 2 இன் கீழ் இலவச மென்பொருளாகும். வரலாறு JSDoc இன் தொடரியல் மற்றும் சொற்பொருள்கள் ஜாவடோக் திட்டத்தைப் போலவே உள்ளன, இது ஜாவாவில் எழுதப்பட்ட குறியீட்டை ஆவணப்படுத்த பயன்படுத்தப்படுகிறது. ஜாவாஸ்கிரிப்ட்டின் மாறும் நடத்தையைக் கையாள்வதில் நிபுணத்துவம் பெற்றதாக இருப்பதால், JSDoc ஜாவடோக்கிலிருந்து வேறுபடுகிறது. ஜாவாஸ்கிரிப்டை ஆவணப்படுத்த ஜாவடோக் போன்ற தொடரமைப்பைப் பயன்படுத்தும் ஒரு ஆரம்ப உதாரணம் 1999 ஆம் ஆண்டில் ஜாவாவில் எழுதப்பட்ட ஜாவாஸ்கிரிப்ட் ரன்-டைம் அமைப்பான நெட்ஸ்கேப்/மொஸில்லா திட்டமான ரைனோவுடன் வெளியிடப்பட்டது. இது ஒரு பொம்மை "ஜேஎஸ்டிஓசி" எச். டி. எம். எல் ஜெனரேட்டரை உள்ளடக்கியது, அதன் ஜாவாஸ்கிரிப்ட் திறன்களுக்கு ஒரு எடுத்துக்காட்டாக 1.3 வரை பதிப்பு செய்யப்பட்டது. "ஜே. எஸ். டி. ஓ. சி" இன் அனைத்து முக்கிய தலைமுறைகளும் மைக்மத்ஸ் (மைக்கேல் மேத்யூஸ்) தலைமையில் இருந்தன. 2001 ஆம் ஆண்டில் கனேடிய புரோகிராமர் கேப்ரியல் ரீடின் ஒத்துழைப்புடன் பெர்ல் மொழியில் எழுதப்பட்ட ஒரு எளிய அமைப்பான JSDoc.pm உடன் அவர் தொடங்கினார். இது ஒரு சி. வி. எஸ் களஞ்சியத்தில் சோர்ஸ்ஃபோர்ஜ் இல் ஹோஸ்ட் செய்யப்பட்டது. ஜேஎஸ்டிஓசி 1.0 (2007) மூலம் அவர் இந்த அமைப்பை ஜாவாஸ்கிரிப்டில் (மீண்டும் ரைனோவுக்காக) மீண்டும் எழுதினார், மேலும் விரிவாக்கங்களின் தொகுப்புக்குப் பிறகு ஜேஎஸ்டிஓசி 2.0 (2008) "ஜேஎஸ்டிஓசி-கருவித்தொகுப்பு" என்ற பெயரைப் பெற்றது. எம்ஐடி உரிமத்தின் கீழ் வெளியிடப்பட்டது, இது கூகிள் குறியீட்டில் ஒரு சப் வெர்சன் களஞ்சியத்தில் ஹோஸ்ட் செய்யப்பட்டது. 2011 வாக்கில் அவர் இந்த அமைப்பை ஜேஎஸ்டிஓசி 3 ஆக மாற்றியமைத்து, முடிவை கிட்ஹப்பில் தொகுத்து வழங்கினார். இது இப்போது Node.js இல் இயங்குகிறது. JSDoc குறிச்சொற்கள் நவீன JSDoc இல் பயன்படுத்தப்படும் மிகவும் பிரபலமான சிறுகுறிப்பு குறிச்சொற்களில் சிலஃ {| வகுப்பு = "விக்கி செய்யக்கூடியது"! டேக்! ! விளக்கம் |-| @author | | டெவலப்பரின் பெயர் |-| @constructor | ஒரு கட்டமைப்பாளராக ஒரு செயல்பாட்டைக் குறிக்கிறது |-| @deprecated | | ஒரு முறையை நீக்கப்பட்டதாக குறிக்கிறது |-| @exception | | @throws |-| @exports | | தொகுதி மூலம் ஏற்றுமதி செய்யப்படும் ஒரு உறுப்பினரை அடையாளம் காட்டுகிறது |-| @param | | ஒரு முறை அளவுருவை ஆவணப்படுத்துகிறது; சுருள் பிரேஸ்களுக்கு இடையில் ஒரு தரவு வகை காட்டி சேர்க்கப்படலாம் |-| @private | ஒரு உறுப்பினர் தனிப்பட்டவர் என்பதைக் குறிக்கிறது |-| @returns | | ஆவணங்கள் ஒரு திரும்ப மதிப்பு |-| <ID12 |-| @throws | | ஒரு முறையால் வீசப்பட்ட விதிவிலக்கான ஆவணங்கள் |-| @version | ஒரு நூலகத்தின் பதிப்பு எண்ணை வழங்குகிறது |} எடுத்துக்காட்டு/* * @class வட்டம் ஒரு வட்டத்தைக் குறிக்கிறது. */வகுப்பு வட்டம் {/* * * வட்டத்தின் ஒரு உதாரணத்தை உருவாக்குகிறது. * * @author: மோய் * @param {எண்} ஆர் வட்டத்தின் விரும்பிய ஆரம். */கட்டமைப்பாளர் (r) {/* * @private */this.radius = r/* @private */this.circumference = 2 * Math.PI * r}/* * * ஒரு விட்டத்திலிருந்து ஒரு புதிய வட்டத்தை உருவாக்குகிறது. * * @param {எண்} d வட்டத்தின் விரும்பிய விட்டம். @return {வட்டம்} புதிய வட்டம் பொருள். */நிலையான இருந்து விட்டம் (d) {திரும்ப புதிய வட்டம் (d/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 பயன்படுத்துகிறது. பிந்தையது அதன் வெளியீட்டு ஜாவாஸ்கிரிப்டை மேம்படுத்த வகை தகவலைப் பிரித்தெடுக்கிறது. டைப்ஸ்கிரிப்ட் JSDoc வகை சிறுகுறிப்புகளுடன் ஜாவாஸ்கிரிப்ட் கோப்புகளுக்கான வகை சரிபார்ப்பை செய்ய முடியும். மைக்ரோசாப்ட் விரிவாக்கக்கூடிய குறிச்சொற்களுடன் ஒரு புதிய டி. எஸ். டி. ஓ. சி மொழியைக் குறிப்பிட்டுள்ளது. பிரபலமான எடிட்டர் சப்ளைம் டெக்ஸ்ட் டாக் பிளாக்கர் அல்லது டாக்ஸிடாக்ஸிஜென் சொருகி மூலம் ஜேஎஸ்டிஓசியை ஆதரிக்கிறது ஜேஎஸ்டிஓசி தொடரியல் அபிரஸ் புத்தகமான ஃபவுண்டேஷன்ஸ் ஆஃப் அஜாக்ஸில் விரிவாக விவரிக்கப்பட்டுள்ளது. இன்டெல்லிஜே ஐடிஇஏ, நெட்பீன்ஸ், விஷுவல் ஸ்டுடியோ கோட் மற்றும் ரூபிமைன் ஆகியவை ஜேஎஸ்டிஓசி தொடரமைப்பைப் புரிந்துகொள்கின்றன. எக்லிப்ஸ் அடிப்படையிலான அப்டானா ஸ்டுடியோ ஸ்கிரிப்ட்டாக்கை ஆதரிக்கிறது. மொசைல், மொசில்லா இன்லைன் எடிட்டர் JSDoc.pm ஐப் பயன்படுத்துகிறது. ஹெல்மா பயன்பாட்டு கட்டமைப்பு JSDoc ஐப் பயன்படுத்துகிறது. ஸ்ப்ரவுட் கோர் ஆவணங்கள் JSDoc ஐப் பயன்படுத்தி உருவாக்கப்பட்டன. விஷுவல் ஸ்டுடியோ, வெப்ஸ்டார்ம் மற்றும் பல ஒருங்கிணைந்த மேம்பாட்டு சூழல்கள் அல்லது உரை எடிட்டர்கள் ஜேஎஸ்டிஓசி கருத்துகளின் அடிப்படையில் குறியீடு நிறைவு மற்றும் பிற உதவிகளை வழங்குகின்றன. திறந்த மூல அணு எடிட்டர் அணு-எளிதான-JSdoc சொருகி வழியாக JSdoc ஐ ஆதரிக்கிறது. மேலும் காண்க ஆவண உருவாக்கிகளின் ஒப்பீடு கூகிள் மூடல் கருவிகள் குறிப்புகள் வெளிப்புற இணைப்புகள் இலவச ஆவண உருவாக்கிகள் ஜாவாஸ்கிரிப்ட் நிரலாக்க கருவிகள்