description یعنی چه؟
تلفظ: دیسکریپشِن · نوع: اسم
معنی description: توضیح، شرح
description اسمِ فعل describe (توصیف کردن) است و یعنی متنی که میگوید یک چیز چیست یا چه کار میکند. در برنامهنویسی همهجا یک جای خالی به این اسم هست: توضیح مخزن در گیتهاب، توضیح یک pull request، توضیح یک پکیج. آنجا در چند جمله مینویسی چه چیزی را عوض کردهای و چرا.
description در جمله
Please write a clear description for your pull request.
لطفاً برای pull request خودت یک توضیح روشن بنویس.
description در کد
{
"name": "quiz-app",
"description": "A small quiz game for learning English words."
}در package.json توضیح پروژه یک جملهی کوتاه است که با A یا An شروع میشود.
نکته
فعل: describe. اسم: description. به تبدیل b به p دقت کن: describe ولی description.
کلمههای مرتبط
- describe: توصیف کردن؛ شرح دادن
- summary: خلاصه
- pull request: درخواست اینکه تغییرهای تو وارد کد اصلی شود
درس این کلمه
description یکی از هشت کلمهی درس «کامنت» در فاز 9: نوشتن از دورهی انگلیسی برای برنامهنویسها است. بقیهی کلمههای این درس:
- code comment: توضیحی که برای آدمها کنار کد مینویسی
- TODO: کاری که هنوز باید انجام شود
- FIXME: نشانهی کدی که خراب است و باید درست شود
- docstring: متن راهنمای یک تابع، درون خود کد
- summary: خلاصه
- explanation: توضیحِ دلیل یا روش کار
- readable: خوانا، راحت برای خواندن