Web-Dev-For-Beginners/translations/ta/7-bank-project/3-data/assignment.md

குறியீட்டுத் திருத்தம் மற்றும் ஆவணம் பணிகள்

கற்றல் நோக்கங்கள்

இந்த பணியை முடிப்பதன் மூலம், நீங்கள் தொழில்முனைவர் சோதனையாளர்கள் தினமும் பயன்படுத்தும் அவசியமான மென்பொருள் மேம்பாட்டுத் திறன்களை பயிற்சி பெறுவீர்கள். நீண்டநேர பயன்பாட்டிற்கு ஏற்ப குறியீட்டை அமைக்க, மறுபடியும் எழுதுதலை குறைக்க உரிய செயற்பாடுகளை கற்றுக்கொள்ளவும், உங்கள் பணி எதிர்கால மேம்பாட்டாளர்களுக்காக (உட்பட உங்கள் தானேயும்!) ஆவணம் உருவாக்கவும் கற்றுக்கொள்வீர்கள்.

சுத்தம் செய்யப்பட்ட, நல்ல முறையில் ஆவணம் செய்யப்பட்ட குறியீடு என்பது பல மேம்பாட்டாளர்கள் சேர்ந்து பணியாற்றும் மற்றும் குறியீட்டு தளங்கள் காலப்போக்கில் வளர்க்கப்படும் உண்மைப் புவி வலை பயன்பாட்டு அட்டவணைகளுக்கு மிகவும் அவசியமாகும்.

பணியின் கண்ணோட்டம்

உங்கள் வங்கியாளர்ப்பயன்பாட்டின் app.js கோப்பு உள்நுழைவு, பதிவு மற்றும் டாஷ்போர்ட் செயல்பாடுகளுடன் மிகுந்த அளவுக்கு பெரிகிறது. இந்த குறியீட்டை தொழில்முறை மேம்பாட்டு நடைமுறைகளை பயன்படுத்தி திருத்தி வாசிக்க எளிதாகவும் பராமரிக்க சுலபமாகவும் மற்றும் மறுபடியும் எழுதுதலை குறைக்கவும் நேரம்.

திறனாய்வு

உங்கள் தற்போதைய app.js குறியீட்டை கீழ்க்காணும் மூன்று முக்கிய திருத்துதல் தொழில்நுட்பங்களை பயன்படுத்தி மாற்றுக:

1. கட்டமைப்பு நிலையானவற்றை பிரித்தெடுக்கவும்

பணி: உங்கள் கோப்பு மேல் பகுதியில் மீண்டும் பயன்படுத்தக்கூடிய நிலையானங்களைக் கொண்ட கட்டமைப்பு பிரிவை உருவாக்கவும்.

நடைமுறை வழிகாட்டுதல்:

• சர்வர் API அடிப்படை URL ஐ (இப்போது பல இடங்களில் நேரடியாக உள்ளது) பிரித்தெடுக்கவும்
• பல செயல்களில் தோன்றும் பிழை செய்திகளுக்கான நிலையானங்களை உருவாக்கவும்
• மிகவும் பயன்படுத்தப்படும் பாதை வழிகள் மற்றும் கூறு ஐடிகளை பிரித்தெடுக்க பரிசீலனை செய்யவும்

எடுத்துக்காட்டு அமைப்பு:

// கட்டமைப்பு நிரந்தரங்கள்
const API_BASE_URL = 'http://localhost:5000/api';
const ROUTES = {
  LOGIN: '/login',
  DASHBOARD: '/dashboard'
};

2. ஒன்றுசேர்ந்த கோரிக்கை செயற்கூறை உருவாக்கவும்

பணி: createAccount() மற்றும் getAccount() இடையேயான மறுபடியை நீக்கி மீண்டும் பயன்படுத்தக்கூடிய sendRequest() என்ற செயல்பாட்டை உருவாக்கவும்.

தேவைகள்:

• GET மற்றும் POST இரு கோரிக்கைகளையும் கையாளவும்
• சரியான பிழை கையாளுதலை உட்படுத்தவும்
• வெவ்வேறு URL இடங்களைக் கையாளவும்
• விருப்பமான கோரிக்கை உடல் தரவை ஏற்றுக்கொள்ள வேண்டும்

செயல்பாட்டின் கையெழுத்து வழிகாட்டுதல்:

async function sendRequest(endpoint, method = 'GET', data = null) {
  // உங்கள் நிறைவேற்றல் இங்கே
}

3. தொழில்முறை குறியீட்டு ஆவணத்தை சேர்க்கவும்

பணி: உங்கள் குறியீட்டை தெளிவான மற்றும் உதவிகரமான கருத்துக்களுடன் ஆவணப்படுத்தவும், உங்கள் தத்துவத்தின் பின்னணியில் உள்ள "ஏன்" என்பதை விளக்கவும்.

ஆவணப்படுத்தான் கொள்கைகள்:

• செயல்பாட்டின் நோக்கம், அளவுருக்கள் மற்றும் திரும்பும் மதிப்புகளை விளக்கும் ஆவணங்கள் சேர்க்கவும்
• சிக்கலான தத்துவம் அல்லது வணிக விதிமுறைகளுக்கு உள்ளடக்க கருத்துக்களைச் சேர்க்கவும்
• சம்பந்தப்பட்ட செயல்பாட்டைத் தொகுத்து பிரிவு தலைப்புகளுடன் பிரிக்கவும்
• எதுவும் தெளிவாக இல்லாத குறியீட்டு படிமங்கள் அல்லது உலாவி சார்ந்த טרிகர்கள் விளக்கப்பட வேண்டும்

எடுத்துக்காட்டு ஆவணப்படுத்தல் பாணி:

/**
 * Authenticates user and redirects to dashboard
 * @param {Event} event - Form submission event
 * @returns {Promise<void>} - Resolves when login process completes
 */
async function login(event) {
  // ஜாவாச்கிரிப்டுடன் கையாள தொடங்குவதற்கு பிற்போக்கு படிவ சமர்ப்பிப்பை தடுக்கும்
  event.preventDefault();
  
  // உங்கள் செயலாக்கம்...
}

வெற்றிமிகு அளவுகோல்கள்

உங்கள் திருத்தப்பட்ட குறியீடு கீழ்க்காணும் தொழில்முறை மேம்பாட்டு நடைமுறைகளை காட்ட வேண்டும்:

சிறந்த செயல்பாடு

• ✅ நிலைகளும் வடிவமைப்பும்: அனைத்து முக்கியச் சரங்களை மற்றும் URL-களை தெளிவான பெயர்களுடன் நிலையாக பிரித்தெடுக்கப்பட்டுள்ளது
• ✅ DRY கொள்கை: பொது கோரிக்கை தத்துவம் மீண்டும் பயன்படுத்தக்கூடிய sendRequest() செயல்பாட்டில் ஒற்றி ஒருங்கிணைக்கப்பட்டுள்ளன
• ✅ ஆவணப்படுத்தல்: செயல்பாடுகள் நோக்கம் மற்றும் அளவுருக்களை விளக்கும் தெளிவான JSDoc கருத்துக்களுடன் உள்ளன
• ✅ அமைப்பு: குறியீடு பகுதி தலைப்புகளுடன் இயக்க வழக்கு முறையில் தொகுக்கப்பட்டுள்ளது மற்றும் ஒருமைத்தன்மை கொண்ட வடிவமைப்பு உள்ளது
• ✅ பிழை கையாளுதல்: புதிய கோரிக்கை செயல்பாட்டை பயன்படுத்தி மேம்பட்ட பிழை கையாளுதல் உள்ளது

போதுமான செயல்பாடு

• ✅ நிலைகள்: பெரும்பாலான மீண்டும் பயன்படுத்தப்படும் மதிப்புகள் பிரிக்கப்பட்டுள்ளன, சில சிறிய நேரடிப் மதிப்புக்களே உள்ளன
• ✅ வகுத்தல்: அடிப்படை sendRequest() செயல்பாடு உருவாக்கப்பட்டுள்ளது, ஆனால் அனைத்து மாறுபாடுகளையும் கையாளக் கூடாது
• ✅ கருத்துக்கள்: முக்கிய செயல்பாடுகள் ஆவணப்படுத்தப்பட்டுள்ளன, சில விளக்கங்கள் இன்னும் முழுமையாக இருக்கலாம்
• ✅ வாசிப்புத் தன்மை: குறியீடு பொதுவாக நன்கு ஒழுங்குபடுத்தப்பட்டுள்ளதுடன் மேம்படுத்த வேண்டிய பகுதிகள் உள்ளன

மேம்படுத்த வேண்டியது

• ❌ நிலைகள்: கோப்பில் பல முக்கிய சரங்கள் மற்றும் URL-கள் நேரடியாக உள்ளன
• ❌ மறு எழுதுதல்: ஒற்றுமையான செயல்களுக்கு இடையில் அதிகளவிலான குறியீட்டு நகல் உள்ளது
• ❌ ஆவணப்படுத்தல்: குறியீட்டின் நோக்கம் விளக்காத அல்லது போதும் அளவில் இல்லாத கருத்துக்கள்
• ❌ அமைப்பு: குறியீடு தெளிவான அமைப்பு மற்றும் காரணமான குழுவாக்கம் இல்லாமல் உள்ளது

உங்கள் திருத்தப்பட்ட குறியீட்டை சோதனை செய்யவும்

திருத்தத்திற்குப் பிறகு, உங்கள் வங்கியாளர் பயன்பாடு சரியான முறையில் இயங்குகிறதா என்பதை உறுதிப்படுத்துக:

1. எல்லா பயனர் ஓட்டுகளும் சோதனை செய்யவும்: பதிவு, உள்நுழைவு, டாஷ்போர்ட் காட்சி மற்றும் பிழை கையாளுதல்
2. API அழைப்புகளை சரிபார்க்கவும்: உங்கள் sendRequest() செயல்பாடு கணக்கு உருவாக்கவும் பெறவும் சரியாக செயல்படுவதை உறுதிப்படுத்த
3. பிழை நிலைகள் சோதனை செய்யவும்: தவறான அங்கீகார விவரங்கள் மற்றும் நெட்வொர்க் பிழைகளுடன் சோதனை செய்யவும்
4. கான்சோல் வெளியீட்டை பரிசீலனை செய்யவும்: திருத்தத்தின் போது புதிய பிழைகள் அறிமுகம் செய்யப்படவில்லை என்பதைக் கண்டறியவும்

சமர்ப்பிக்க வழிகாட்டல்கள்

உங்கள் திருத்தப்பட்ட app.js கோப்பை பின்வருமாறு சமர்ப்பிக்கவும்:

• வெவ்வேறு செயல்பாடுகளை ஒழுங்குபடுத்தும் தெளிவான பிரிவு தலைப்புகள்
• ஒருமைத்தன்மையான குறியீடு வடிவமைப்பு மற்றும் இடைவெளிகள்
• அனைத்து செயல்பாடுகளுக்குமான முழுமையான JSDoc ஆவணங்கள்
• மேல் பகுதியில் உங்கள் திருத்த முறையை விளக்கும் சுருக்கமான கருத்து

விரும்பத்தக்க சவால்: உங்கள் பயன்பாட்டின் கட்டமைப்பையும் வெவ்வேறு செயல்பாடுகள் ஒன்றிணைந்து எப்படி வேலை செய்கின்றன என்பதையும் விளக்கும் எளிய குறியீடு ஆவணத் தொகுப்பை (CODE_STRUCTURE.md) உருவாக்கவும்.

உண்மை உலகின் தொடர்பு

இந்த பணி தொழில்முறை மேம்பாட்டாளர்கள் அடிக்கடி செய்யும் குறியீட்டு பராமரிப்பு வகையை பிரதிபலிக்கிறது. தொழில்துறை சூழலில்:

• குறியீடு ஆய்வுகள் இந்த பணிக்கு ஒத்த வாசிப்புத் திறன் மற்றும் பராமரிப்பு திறனை மதிப்பிடும்
• தொழில்நுட்ப கடன் குறியீடு முறையாக திருத்தப்பட்டு ஆவணம் செய்யப்படாதபோது கூடும்
• குழு ஒத்துழைப்பு தெளிவாக மற்றும் நன்கு ஆவணப்படுத்தப்பட்ட குறியீடுக்கு சார்ந்தது, புதிய குழு உறுப்பினர்கள் அதை புரிந்துகொள்ள முடியும்
• பிழை சரிசெய்தல்கள் தரமான பன்முக குறியீட்டு தளங்களில் உள்ள வெற்றியளவில் எளிதாக இருக்கும்

நீங்கள் இங்கே பயிற்சி பெறும் திறன்கள் - நிலையானவற்றை பிரித்தெடுக்கும், மறுபடியை நீக்கும் மற்றும் தெளிவான ஆவணப்படுத்தலை எழுதுதல் - தொழில்முறை மென்பொருள் மேம்பாட்டிற்கு அடிப்படையாகும்.

---

கவனிப்பு:
இந்த ஆவணம் Co-op Translator என்ற ஏ.ஐ. மொழிபெயர்ப்பு சேவையை பயன்படுத்தி மொழிபெயர்க்கப்பட்டுள்ளது. நாங்கள் துல்லியத்திற்காக முயற்சி செய்கிறோம் என்றாலும், தானியங்கி மொழிபெயர்ப்புகளில் பிழைகள் அல்லது தவறான தகவல்கள் இருக்கக்கூடும் என்பதை கவனத்தில் கொள்ளவும். உண்மையான ஆவணத்தின் சொந்த மொழி தான் அதிகாரபூர்வமான ஆதாரமாக கருதி கொள்ளப்பட வேண்டும். முக்கியத் தகவல்களுக்காக, தொழில்முறை மனித மொழிபெயர்ப்பை பரிந்துரைக்கின்றோம். இந்த மொழிபெயர்ப்பின் பயன்படுத்தியதனால் ஏற்படும் எந்த தவறான புரிதல்கள் அல்லது தவறான விளக்கங்களுக்கு நாங்கள் பொறுப்பேற்றுக் கொள்ளமாட்டோம்.