code comment یعنی چه؟
تلفظ: کُد کامِنت · نوع: اسم
معنی code comment: توضیحی که برای آدمها کنار کد مینویسی
comment در انگلیسی یعنی «نظر» یا «توضیح». code comment خطی است که کامپیوتر آن را نادیده میگیرد و فقط برای آدمی نوشته شده که بعداً کد را میخواند (که خیلی وقتها خود تو هستی). کامنت خوب نمیگوید کد «چه کار» میکند، چون آن را خود کد میگوید؛ میگوید «چرا» اینطور نوشته شده. کامنت را کوتاه، با زمان حال ساده و با حرف بزرگ در اول جمله بنویس.
code comment در جمله
Add a short code comment to explain why we skip the first row.
یک کامنت کوتاه اضافه کن که توضیح بدهد چرا ردیف اول را رد میکنیم.
code comment در کد
# Skip the first row because it is the header.
for row in rows[1:]:
save(row)کامنت دلیل را میگوید (because…)، نه اینکه «یک حلقه داریم».
نکته
کامنت بد: «Add 1 to i». کامنت خوب: «Start from 1 because row 0 is the header».
کلمههای مرتبط
- comment: نظر، یادداشت کوتاه زیر یک نوشته
- hash sign: علامت #
- docstring: متن راهنمای یک تابع، درون خود کد
درس این کلمه
code comment یکی از هشت کلمهی درس «کامنت» در فاز 9: نوشتن از دورهی انگلیسی برای برنامهنویسها است. بقیهی کلمههای این درس:
- TODO: کاری که هنوز باید انجام شود
- FIXME: نشانهی کدی که خراب است و باید درست شود
- docstring: متن راهنمای یک تابع، درون خود کد
- description: توضیح، شرح
- summary: خلاصه
- explanation: توضیحِ دلیل یا روش کار
- readable: خوانا، راحت برای خواندن