مقدمه

وقتی داخل یونیتی یه اسکریپت جدید برای گیم آبجکتمون ایجاد میکنیم اون اسکریپت بر پایه قالب پیشفرضی که معین شده یه سری کد اولیه داره که توش متد های start و update و کمی کامنت و یه سری using های ابتدای کد هست.

اما شاید براتون جالب باشه که بدونید یونیتی به شما این امکان رو میده که قالب پیشفرض اسکریپت های MonoBehaviour و همچنین شیدر ها و یه سری کد های دیگه رو ویرایش کنید،مثلا اول هرکدومشون اسم شما یا گروه شما ثبت شه یا متن کپی رایت و ..

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

A standard header is also recommended. Including a standard header in your code template helps you document the purpose of a class, the date it was created, and even who created it; essentially, all of the information that could easily get lost in the long history of a project, even when using version control.

 

این آموزش با یونیتی 2019 تست شده اما انتظارمیره در همه نسخه ها تغییر کماکان به همین روش انجام بشه.

نحوه ویرایش قالب این کد ها

مسیر قالب پیشفرض اسکریپت های یونیتی در ویندوز

[UNITY FOLDER]\Editor\Data\Resources\ScriptTemplates

UnityFolder : مسیر پوشه یونیتی شما

در مک:

Applications/Hub/Editor/[version]/Unity/Unity.app/Contents/ Resources/ScriptTemplates

داخل این پوشه فایل قالب های مختلف رو میبینید(تصویر از پوشه در نسخه ویندوزی)

محتویات پوشه قالب قالب های پیشفرض اسکریپت- یونیتی 2019.4.10f1

محتویات پوشه قالب قالب های پیشفرض اسکریپت- یونیتی 2019.4.10f1

 

برای اسکریپت های MonoBehavour این فایل نقش قالب رو ایفا میکنه(فایل اول توی تصویر):
81-C# Script-NewBehaviourScript.cs.txt

مثلا با ویرایش اسکریپت به این شکل میتونید کاری کنید که اسکریپت های مونو بالاش یه کامنت باشه تا بتونیم توضیحات مربوط به اون اسکریپت رو وارد کنیم

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

/*----------------------------------
----------------------------------
Creation Date: #DATETIME#
Author: #DEVELOPER#
Description:
----------------------------------
----------------------------------
*/
public class #SCRIPTNAME# : MonoBehaviour

{
// Start is called before the first frame update
void Start()
{
#NOTRIM#
}

// Update is called once per frame
void Update()
{
#NOTRIM#
}
}
مثال از کد اسکریپت جدید ایجاد شده شامل متن هدر شخصی سازی شده

مثال از کد اسکریپت جدید ایجاد شده شامل متن هدر شخصی سازی شده

بدیهیه که میتونید حتی متد های پیشفرض مثل Start و Update رو حذف یا اضافه و کامنتشون رو تغییر بدید.
طبق گفته یونیتی اگه توی پوشه Assets یه پوشه جدید ایجاد کنید با عنوان ScriptTemplates میتونید قالب رو اختصاصی هر پروژتون ایجاد کنید(بجای اینکه روی همه پروژه ها اعمال بشه).

 

به شخصه از این روش برای گذاشتن یه بلوک کامنت که محلی برای ثبت مشخصات اون کلاسه استفاده کردم که هم بهم یاد آوری کنه برای کلاس ها کمنت بذارم هم برام کامنت گذاری رو منسجم تر و راحت تر میکنه.

 

پایان.

 

 

 

پی نوشت

شاید همه راحت نباشن که توی همه فایلهاشون این کامنت باشه اما دونستن کلی این ساز و کار ممکنه در آینده بدردتون بخوره،مثلا در حال آماده کردن یه پروژه بزرگید و میدونید بعدا با زیاد شدن اسکریپت هاش به همچین چیزی نیاز پیدا میکنید.

این پست برگرفته از یه پست آموزشی خیلی خوب از سایت خود یونیتی هست که میتونید توضحات کاملتر چیزی که خوندید و یه سری نکته برای بهتر سازماندهی کردن پروژه های یونیتی هم داخلش پیدا کنید!

https://unity.com/how-to/organizing-your-project#code-standards