قواعد نوشتن کد تمیز

people

احسان سعیدپور

    قوانین عمومی

    • قوانین استاندارد را دنبال کنید.
    • ساده تر همیشه بهتر است. به حداقل ممکن پیچیدگی را کم کنید.
    • از پاک کردن کد تا یافتن راهکار بهتر خودداری کنید. همیشه به ریسک یک مشکل نگاه کنید.

    قوانین قابل فهم بودن

    • استوار باشید؛ اگر چیزی را به روش خاصی انجام می دهید، همه چیزهای مشابه را به همان روش انجام دهید.
    • از متغیرهای توضیحی استفاده کنید.
    • از شرایط منفی خودداری نمایید.

    قوانین طراحی

    • داده های قابل تنظیم را در سطوح بالا نگه دارید.
    • پلی مورفیسم را به if/else ترجیح دهید.
    • کدهای چند thread را جدا نمایید.
    • از dependency-injection استفاده کنید.
    • یک کلاس باید فقط وابستگی مستقیم خود را بداند.

    قوانین نام گذاری

    • نام های توصیفی و یکنواخت را انتخاب کنید.
    • از اسم های معنادار استفاده کنید.
    • از نام های قابل تلفظ و قابل جستجو استفاده کنید.
    • بجای استفاده از اعداد متغیر از نام های ثابت استفاده کنید.
    • از رمزگذاری اضافه کردن پیشوند و تایپ اطلاعات اجتناب کنید.

    قوانین توابع

    • کوچک
    • یک چیز را انجام دهد.
    • استفاده از نام های توصیفی
    • استفاده از آرگومان های کمتر
    • عوارض جانبی نداشته باشد.

    قوانین کامنت گذاری

    • همیشه سعی کنید توضیحاتی را برای درک خود در کد بگذارید.
    • از کامنت های بیهوده بپرهیزید
    • به عنوان توضیح مقصود و کد استفاده کیند
    • به منظور هشدار از پیامدها استفاده کنید.

    قوانین سورس کد

    • مفاهیم را به صورت عمودی مرتب سازی نمایید.
    • متغیرها را نزدیک به جایی که می خواهید استفاده کنید تعریف نمایید
    • توابع وابسته باید نزدیک به هم باشند.
    • توابع مشابه باید نزدیک به هم باشند.
    • از طولانی شدن خط کدها بپرهیزید.
    • کدها را قطعه قطعه نکنید.

    مقالات مرتبط با قواعد نوشتن کد تمیز