3.7 KiB
کامنتگذاری روی کد
دستورالعملها
کدی تمیز و مستندسازی شده برای نگهداری و به اشتراکگذاری پروژههایتان ضروری است. در این تمرین، شما یکی از مهمترین عادات توسعهدهندگان حرفهای را تمرین خواهید کرد: نوشتن کامنتهای واضح و مفید که هدف و عملکرد کدتان را توضیح میدهد.
فایل app.js کنونی خود در پوشه بازیتان را مرور کنید و راههایی برای کامنتگذاری و مرتب کردن آن پیدا کنید. خیلی آسان است که کد از کنترل خارج شود، و حالا فرصت خوبی است که کامنت اضافه کنید تا مطمئن شوید کد قابل خواندن است و بتوانید بعداً از آن استفاده کنید.
وظیفه شما شامل موارد زیر است:
- اضافه کردن کامنت برای توضیح اینکه هر بخش اصلی کد چه کاری انجام میدهد
- مستندسازی توابع با توضیحات واضح درباره هدف آنها و پارامترهایشان
- سازماندهی کد در بلوکهای منطقی با عنوانهای بخش
- حذف هر کد استفاده نشده یا تکراری
- استفاده از نامگذاری یکدست برای متغیرها و توابع
معیار ارزیابی
| معیار | عالی | کافی | نیاز به بهبود |
|---|---|---|---|
| مستندسازی کد | کد app.js کاملاً کامنتگذاری شده با توضیحات واضح و مفید برای تمام بخشها و توابع اصلی |
کد app.js به طور کافی با توضیحات پایه برای بیشتر بخشها کامنتگذاری شده است |
کد app.js کامنتهای کمی دارد و فاقد توضیحات واضح است |
| سازماندهی کد | کد در بلوکهای منطقی با عنوانهای بخش واضح و ساختار یکدست سازماندهی شده است | کد تا حدی سازماندهی شده با گروهبندی پایهای از قابلیتهای مرتبط است | کد کمی نامنظم و دشوار برای دنبال کردن است |
| کیفیت کد | تمامی متغیرها و توابع نامهای توصیفی دارند، کد استفاده نشده ندارد، و از قراردادهای یکدست پیروی میکند | بیشتر کد از نامگذاری مناسب پیروی میکند با حداقل کد استفاده نشده | نام متغیرها نامشخص است، کد استفاده نشده دارد و سبک نامنظم است |
سلب مسئولیت: این سند با استفاده از سرویس ترجمه ماشینی Co-op Translator ترجمه شده است. در حالی که ما برای دقت تلاش میکنیم، لطفاً توجه داشته باشید که ترجمههای خودکار ممکن است حاوی خطاها یا نواقصی باشند. سند اصلی به زبان بومی آن باید بهعنوان منبع معتبر در نظر گرفته شود. برای اطلاعات حیاتی، توصیه میشود از ترجمه حرفهای انسانی استفاده شود. ما مسئول هیچ گونه سوءتفاهم یا تفسیر نادرستی که ناشی از استفاده از این ترجمه باشد، نیستیم.