بتل کد Battle Codeدارد باز می‌شود…

سبک نوشتن اسم

اسم متغیر نمی‌تواند فاصله داشته باشد، پس برای چسباندن کلمه‌ها چند سبک ساخته‌اند. هر زبان سبک خودش را دارد و اسم این سبک‌ها بامزه است: شتر، مار و کباب.

چند اسم پشت سر هم

در انگلیسی می‌شود چند اسم را بدون هیچ حرف اضافه‌ای پشت هم گذاشت و اسم اصلی همیشه آخری است: user name یعنی «نامِ کاربر» و user name list یعنی «فهرستِ نامِ کاربرها». برای فهمیدنش از آخر به اول بخوان. اسم متغیرها دقیقاً همین‌طور ساخته می‌شوند: file_size_limit یعنی «سقفِ اندازه‌ی فایل».

هشت کلمه‌ی این درس

camel case (کَمِل کِیس): سبک شتری: کلمه‌ها چسبیده، هر کلمه با حرف بزرگ

camel یعنی «شتر». در این سبک، کلمه‌های یک اسم را به هم می‌چسبانی و اول هر کلمه (جز اولی) را بزرگ می‌نویسی: userName، totalPrice، getUserById. حرف‌های بزرگِ وسط اسم مثل کوهان شتر بالا زده‌اند. جاوااسکریپت و جاوا برای متغیر و تابع همین سبک را به کار می‌برند.

In JavaScript, function names are written in camel case.

در جاوااسکریپت اسم تابع‌ها را به سبک شتری می‌نویسند.

snake case (اِسنِیک کِیس): سبک ماری: کلمه‌ها با زیرخط جدا می‌شوند

snake یعنی «مار». در این سبک همه‌ی حرف‌ها کوچک‌اند و بین کلمه‌ها زیرخط (_) می‌گذاری: user_name، total_price، get_user_by_id. اسم مثل ماری است که روی زمین دراز کشیده. پایتون برای متغیر و تابع همین سبک را می‌خواهد و اسم ستون‌های پایگاه داده هم معمولاً همین‌طور است.

Python uses snake case for variable and function names.

پایتون برای اسم متغیرها و تابع‌ها سبک ماری را به کار می‌برد.

kebab case (کِباب کِیس): سبک کبابی: کلمه‌ها با خط تیره جدا می‌شوند

kebab همان کباب خودمان است! در این سبک همه‌ی حرف‌ها کوچک‌اند و بین کلمه‌ها خط تیره (-) می‌آید: user-name، main-menu. کلمه‌ها مثل تکه‌های گوشت روی سیخ ردیف شده‌اند. در اسم کلاس‌های CSS، نشانی صفحه‌ها (URL) و اسم فایل‌ها زیاد می‌بینی‌اش.

CSS class names are usually written in kebab case.

اسم کلاس‌های CSS را معمولاً به سبک کبابی می‌نویسند.

uppercase (آپِرکِیس): حروف بزرگ انگلیسی

uppercase یعنی حروف بزرگ: A، B، C. اسمش از چاپخانه‌های قدیم می‌آید: حروف سربیِ بزرگ را در جعبه‌ی بالایی (upper case) و حروف کوچک را در جعبه‌ی پایینی نگه می‌داشتند. در کد، اسمی که تمامش بزرگ باشد یعنی «این یک ثابت است، عوضش نکن»: MAX_SPEED، API_KEY.

Your password must contain at least one uppercase letter.

رمز عبورت باید دست‌کم یک حرف بزرگ داشته باشد.

lowercase (لُوِرکِیس): حروف کوچک انگلیسی

lowercase یعنی حروف کوچک: a، b، c. lower یعنی «پایین‌تر» و اسمش از همان جعبه‌ی پایینیِ حروف در چاپخانه می‌آید. بیشترِ کد با حروف کوچک نوشته می‌شود. یک کاربرد مهمش در مقایسه است: قبل از مقایسه‌ی دو متن، هر دو را lowercase می‌کنی تا Sara و sara یکی حساب شوند.

Email addresses are converted to lowercase before saving.

نشانی‌های ایمیل پیش از ذخیره شدن به حروف کوچک تبدیل می‌شوند.

prefix (پری‌فیکس): پیشوند، تکه‌ای که اول اسم می‌آید

prefix از pre- (پیش) و fix (چسباندن) ساخته شده: چیزی که به اولِ یک کلمه می‌چسبد. در اسم‌گذاری، پیشوندها خبر می‌دهند که با چه چیزی طرفی: is و has یعنی جواب true یا false است، get یعنی چیزی برمی‌گرداند و زیرخطِ اول اسم (_name) در پایتون یعنی «این خصوصی است، دست نزن».

All test functions must have the prefix test_.

همه‌ی تابع‌های تست باید پیشوند ‎test_ داشته باشند.

suffix (سافیکس): پسوند، تکه‌ای که آخر اسم می‌آید

suffix تکه‌ای است که به آخرِ یک کلمه می‌چسبد و جفت prefix است. در اسم‌گذاری، پسوند معمولاً جنس چیز را می‌گوید: user_list یک فهرست است، user_count یک عدد، user_id یک شناسه و saveButton یک دکمه. پسوند فایل (.py، .png) هم نوعی suffix است.

Add the suffix _id to columns that store an ID.

به ستون‌هایی که شناسه نگه می‌دارند پسوند ‎_id اضافه کن.

abbreviation (اَبری‌وی‌اِیشِن): شکل کوتاه‌شده‌ی یک کلمه

abbreviation یعنی «کوتاه‌نوشت»: شکل کوتاه یک کلمه یا عبارت. کد پر از آن‌هاست: btn برای button، msg برای message، img برای image، max برای maximum. کوتاه‌نوشت‌های معروف خوب‌اند چون همه می‌شناسندشان، ولی کوتاه‌نوشتِ من‌درآوردی کد را مثل معما می‌کند: usrCntTmp را چه کسی می‌فهمد؟

Avoid any abbreviation that your team does not know.

از هر کوتاه‌نوشتی که تیمت نمی‌شناسد دوری کن.

بخشی از راهنمای سبک کد

Style guide: names

- Python variables and functions use snake case: user_name, get_total().
- JavaScript variables and functions use camel case: userName, getTotal().
- CSS classes and file names use kebab case: main-menu, user-card.css.
- Constants are written in uppercase with underscores: MAX_USERS.
- All other names start with a lowercase letter.
- Use the prefix is_ for true/false values and the suffix _count for numbers of things.
- Do not use an abbreviation unless everyone knows it. Write message, not msg.

راهنمای سبک: اسم‌ها

- متغیرها و تابع‌های پایتون سبک ماری دارند: user_name، get_total().
- متغیرها و تابع‌های جاوااسکریپت سبک شتری دارند: userName، getTotal().
- کلاس‌های CSS و اسم فایل‌ها سبک کبابی دارند: main-menu، user-card.css.
- ثابت‌ها با حروف بزرگ و زیرخط نوشته می‌شوند: MAX_USERS.
- همه‌ی اسم‌های دیگر با حرف کوچک شروع می‌شوند.
- برای مقدارهای true و false پیشوند ‎is_ و برای تعداد چیزها پسوند ‎_count به کار ببر.
- کوتاه‌نوشت به کار نبر مگر این‌که همه آن را بشناسند. بنویس message، نه msg.