سبک کدنویسی

فضای خالی

• یک عبارت و دستور به ازای هر خط.
• استفاده از فضای خالی به جای تب سخت افزاری.
• هر تو رفتگی شامل 4 ستون شود.

قراردادهای نامگذاری

نام متغیرها باید camelCase باشد. بنابراین، نام هایی که از به هم پیوستن چند کلمه تشکیل می شوند، هر کلمه ای غیر از کلمه اول را با حروف بزرگ نوشته می شود. همچنین نام توابع باید با زیرخط «_» تقسیم شود.

function myFunc()
var myLocalVar : int?

نام ماژول ها و بسته ها باید همه با حروف کوچک باشد و فقط شامل کاراکترهای [a..z][0..9][_] باشد. این امر هنگام برخورد با سیستم های فایل حساس به حروف کوچک و بزرگ از مشکلات جلوگیری می کند:

use ctypto.sha256

نام انواع تعریف شده توسط کاربر باید PascalCased باشد که همان camelCased است با این تفاوت که حرف اول آن بزرگ است:

struct FooAndBar {
    var x = 0
}
enum Colors{
    red,
    blue,
    green
}

نام ثابت ها باید CAPITALCASED باشد:

const PI : float = 3.14

اگر نامی با یک کلمه کلیدی مغایرت داشته باشد و بهتر است از کلمه کلیدی به جای انتخاب نام دیگری استفاده شود، یک زیرخط «_» باید به آن اضافه شود. برای جلوگیری از تضاد با کلمات کلیدی، نام ها نباید با حروف بزرگ نوشته شوند:

enum Types{
    string_,
    int_,
    float_
}

تعریف متغییر

زمانی که متغیرها را تعریف می کنید، همیشه یک مقدار به آنها اختصاص دهید استفاده از متغیر nullable در برنامه‌تان را کاهش دهید..

var localVar : int = 12 // good
var localVar2 : int? // bad
localVar2 = 12

واردات

• واردات محلی باید بر واردات عمومی ترجیح داده شود.
• واردات باید از نظر لغوی مرتب شده باشند.

ما لزوماً توصیه نمی کنیم که همه کدها از این قوانین پیروی کنند، اما Pull Request های ارسال شده به کتابخانه استاندارد ساکالون باید از این قوانین پیروی کنند.
آیا پیشنهادی برای بهبود این قوانین دارید یا ایده ای برای قوانین جدید؟ یک موضوع را در مخزن گیت هاب ساکالون باز کنید.