ایجاد File Templates در محصولات JetBrains

اگر با محصولات شرکت JetBrains کار می کنید این مقاله برای شما ارزشمند خواهد بود چرا که با مواردی که در این مقاله آموزش می بینید ، کدنویسی اصولی تر را اجرا خواهید کرد .

File Templates در محصولات JetBrains چیست ؟

"File Templates" در محصولات JetBrains مانند CLion، IntelliJ IDEA، PyCharm و دیگر IDE های این شرکت، ابزاری است که به توسعه‌دهندگان اجازه می‌دهد تا قالب‌های از پیش تعریف‌شده‌ای برای فایل‌های جدید ایجاد کنند. این قالب‌ها می‌توانند شامل ساختار پایه‌ای کد، کامنت‌ها، و هر نوع محتوای دیگری باشند که به طور مکرر در پروژه‌ها استفاده می‌شوند.

ویژگی‌ها و مزایا:

1. صرفه‌جویی در زمان:

   • با استفاده از تمپلیت‌ها، می‌توانید به سرعت فایل‌های جدید با ساختارهای استاندارد و تکراری را ایجاد کنید.

2. یکپارچگی و سازگاری:

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

3. شخصی‌سازی و انعطاف‌پذیری:

   • شما می‌توانید تمپلیت‌ها را بر اساس نیازهای خاص پروژه‌ها یا تیم خود شخصی‌سازی کنید.

در File Templates شما می توانید از متغییرهایی که از قبل تعریف شده است استفاده کنید که در اینجا لیست کامل به همراه توضیحات آن را شرح خواهیم داد.

1. ${DATE}

   • ترجمه: تاریخ
   • توضیح: تاریخ فعلی سیستم

2. ${DAY}

   • ترجمه: روز
   • توضیح: روز فعلی ماه

3. ${DAY_NAME_SHORT}

   • ترجمه: نام کوتاه روز
   • توضیح: سه حرف اول نام روز فعلی (مانند Mon برای Monday)

4. ${DAY_NAME_FULL}

   • ترجمه: نام کامل روز
   • توضیح: نام کامل روز فعلی (مانند Monday)

5. ${DIR_PATH}

   • ترجمه: مسیر دایرکتوری
   • توضیح: مسیر دایرکتوری فایل جدید (نسبت به ریشه پروژه)

6. ${DS}

   • ترجمه: علامت دلار
   • توضیح: علامت دلار ($). این متغیر برای جلوگیری از تفسیر علامت دلار به عنوان پیشوند متغیر استفاده می‌شود.

7. ${FILE_NAME}

   • ترجمه: نام فایل
   • توضیح: نام فایل جدید

8. ${HOUR}

   • ترجمه: ساعت
   • توضیح: ساعت فعلی

9. ${MINUTE}

   • ترجمه: دقیقه
   • توضیح: دقیقه فعلی

10. ${SECOND}

    • ترجمه: ثانیه
    • توضیح: ثانیه فعلی

11. ${MONTH}

    • ترجمه: ماه
    • توضیح: ماه فعلی

12. ${MONTH_NAME_SHORT}

    • ترجمه: نام کوتاه ماه
    • توضیح: سه حرف اول نام ماه فعلی (مانند Jan برای January)

13. ${MONTH_NAME_FULL}

    • ترجمه: نام کامل ماه
    • توضیح: نام کامل ماه فعلی (مانند January)

14. ${NAME}

    • ترجمه: نام
    • توضیح: نام موجودیت جدید (فایل، نوع، اینترفیس و غیره)

15. ${ORGANIZATION_NAME}

    • ترجمه: نام سازمان
    • توضیح: نام سازمان شما که در تنظیمات پروژه مشخص شده است

16. ${PRODUCT_NAME}

    • ترجمه: نام محصول
    • توضیح: نام محیط توسعه یکپارچه (IDE)

17. ${PROJECT_NAME}

    • ترجمه: نام پروژه
    • توضیح: نام پروژه فعلی

18. ${TIME}

    • ترجمه: زمان
    • توضیح: زمان فعلی سیستم

19. ${USER}

    • ترجمه: نام کاربری
    • توضیح: نام کاربری سیستم فعلی

20. ${YEAR}

    • ترجمه: سال
    • توضیح: سال فعلی

این متغیرها در قالب‌های فایل استفاده می‌شوند و زمانی که در ویرایشگر توسعه استفاده می‌شوند، به مقادیر متناظرشان تبدیل می‌شوند. متغیرهای سفارشی نیز با فرمت ${VARIABLE_NAME} قابل تعریف هستند و قبل از ایجاد فایل جدید، می‌توانید مقادیر آن‌ها را در یک دیالوگ مشخص کنید.

آموزش ایجاد یک File Templates در یکی از محصولات JetBrains

1. باز کردن تنظیمات CLion:

   • به منوی File بروید و روی Settings کلیک کنید (در مک CLion -> Preferences).

2. تنظیمات تمپلیت‌ها:

   • در پنجره تنظیمات، به قسمت Editor بروید و سپس File and Code Templates را انتخاب کنید.

3. ایجاد یا ویرایش تمپلیت:

• • در این بخش، می‌توانید تمپلیت‌های موجود را ببینید. برای ایجاد یک تمپلیت جدید، روی دکمه + کلیک کنید و یک نام برای تمپلیت خود انتخاب کنید (مثلاً C++ File Template).
  • در قسمت File Name یک نام پیش‌فرض برای فایل بنویسید (مثلاً *.cpp).
  • در بخش Template Text، کد کامنت و هر محتوای دیگری که می‌خواهید به فایل‌های جدید اضافه شود را وارد کنید. برای مثال:

/*
 **********************************************************************
 * -------------------------------------------------------------------
 * Project Name : ${PROJECT_NAME}
 * File Name    : ${FILE_NAME}
 * Author       : Ebrahim Shafiei (EbraSha)
 * Email        : [email protected]
 * Created On   : ${DATE}
 * Description  : [A brief description of what this file does]
 * -------------------------------------------------------------------
 *
 * "Coding is an engaging and beloved hobby for me. I passionately and insatiably pursue knowledge in cybersecurity and programming."
 * – Ebrahim Shafiei
 *
 **********************************************************************
 */

4. ذخیره تمپلیت:

   • پس از وارد کردن متن تمپلیت، روی Apply و سپس OK کلیک کنید تا تنظیمات ذخیره شود.

5. ایجاد فایل جدید با تمپلیت:

   • حالا وقتی یک فایل جدید در CLion ایجاد می‌کنید (File -> New -> C++ File)، می‌توانید تمپلیت جدید خود را انتخاب کنید و به صورت خودکار این قالب به فایل جدید شما اضافه می‌شود.

این روش به شما امکان می‌دهد تا به صورت خودکار و سریع کامنت‌ها و قالب‌های مورد نظر خود را به فایل‌های جدید اضافه کنید و در زمان خود صرفه‌جویی کنید.