به چیدمان کدها توجه کنید!

اگر تجربه ی کدنویسی برنامه های نسبتاً بزرگ را داشته باشید حتماً متوجه شده اید که بیش تر وقت خود را به جای نوشتن کدهای جدید صرف مرور کدهای قبلی کرده اید تا تغییراتی را که لازم است در آن ها اعمال کنید و اشکالات آن ها را رفع نمایید. یکی از فاکتورهای مهمی که سرعت و کارایی شما را در مرور کدها تعیین می کند چیدمان کدها (Code Layout) است. یک چیدمان خوب با تورفتگی های صحیح و قرار دادن میزان فضای سفید مناسب، تفاوت چشمگیری را در مدت زمانی که طول می کشد تا دستورات یک کد را بررسی کنید و منظور آن ها را بفهمید ایجاد می کند. در این آموزش قصد داریم راه کارهایی را برای بهینه سازی نحوه ی چیدمان و آرایش کدها مطرح کنیم.

پویش کدها را ساده تر کنید: فرض کنید تیم شما برنامه ای نوشته است که چندین کلاس مختلف دارد. در هنگام اجرای کلاس های برنامه، برای کامپایلر تفاوتی ندارد که در بدنه ی کلاس ابتدا عناصر public تعریف شده اند یا عناصر private، یا این که ابتدا ثابت ها تعریف شوند یا فیلدها و یا متد ها؛ به عبارت دیگر، ترتیب قرار گرفتن اجزای یک کلاس برای کامپایلر تفاوتی ندارد، اما برای شما چه طور؟

باید بدانید که افراد غالباً در تطبیق الگوهای بصری خوب هستند، بنابراین یکی از رویکردهایی که می توانید با دنبال کردن آن، مرور کدهای خود را آسان تر کنید این است که الگویی برای قرار دادن عناصر برنامه در کدهای خود تعریف کنید و تمام اعضای تیم در زمان کدنویسی بخش های مختلف برنامه از آن الگو پیروی کنند. به عنوان نمونه، می‌توان زبان برنامه نویسی پی اچ پی را مثال زد. سایتی تحت عنوان php-fig.org استانداردی تحت عنوان PSR که مخفف واژگان PHP Standard Recommendation است را برای برنامه نویسان پی اچ پی طراحی کرده که علاقمندان با استفاده از این استانداردها می توانند از کدهایی برخوردار شوند که سایر برنامه نویسان پی اچ پی با نگاه کردن به کدهای ایشان کمتر دچار سردرگمی شوند

برای روشن تر شدن این مسئله، از سایر زبان های برنامه نویسی هم چند مثال می زنیم. اکثر برنامه نویسان ++C ابتدا تعریف متدهای public را در بدنه ی کدهای خود قرار می دهند و در زیر آن ها متدهای private را، در حالی که این رویه در کدنویسی به زبان #C کاملاً برعکس است. البته توجه کنید که ما این الگوها را به طور تجربی در زمان یادگیری هر زبان از منابع آموزش دهنده دریافت کرده و ناخواسته از آن ها تبعیت می کنیم و پیروی از آن ها باعث می شود سایر برنامه نویسان هم به راحتی کدهای ما را بخوانند، با این حال شما می توانید استاندارد مخصوصی برای خود تعریف کنید تا تمام اعضای تیم از آن تبعیت کنند.

چیدمان کدها را طوری تنظیم کنید که منظور کدها را برساند: یکی از توصیه هایی که همیشه به برنامه نویسان می شود این است که در زمان نام گذاری کلاس ها، متغیرها، متدها، و سایر عناصر برنامه از اسامی با معنا استفاده کنند که تا حد ممکن نشان دهد که هر عنصر برنامه چه کاری انجام می دهد. باید بدانید که چیدمان کدها نیز باید به گونه ای باشد که تا جای ممکن منظور کدها را به روشنی مشخص کند. اگر شما کدهای خود را در یک ویرایش گر ساده ی متن بنویسید زحمت تنظیم چیدمان آن بر عهده ی خودتان است، اما امروزه بیش تر برنامه نویسان از محیط های توسعه ی یکپارچه (IDE) مثل اکلیپس استفاده می کنند که می توانند به صورت خودکار چیدمان کدها را تعیین می کنند. با این وجود توصیه ای که به شما داریم این است که همیشه در نظر داشته باشید که این ابزارها نمی توانند منظور شما را از کدهایی که نوشته اید بفهمند، بنابراین گاهی لازم است به صورت دستی تغییراتی را در چیدمان کدها ایجاد کنید تا منظور خود را شفاف سازید.

چیدمان خود را تا جای ممکن فشرده سازید: اکثر برنامه نویسان زمانی که در یک محیط توسعه کد می زنند هر کامند یا دستوری را در یک خط جداگانه وارد می کنند، تا جایی که می بینیم بیش تر دستورات حتی تا پایان خط هم ادامه پیدا نمی کنند، بنابراین در پایان کار برنامه ای با خطوط زیادی کد و فضاهای خالی بی شمار دارند. با این حال باید بدانید که بهترین رویکرد این است که چیدمان خود را -تا جایی که به خوانایی کدها لطمه ای نزند- فشرده سازید. مزیت این کار آن است که حرکت میان کدها راحت تر و سریع تر می شود (به خصوص در برنامه های بزرگ)، یا به طور مثال در برنامه های تحت وب حجم داده هایی که از سمت سرور به کلاینت ها ارسال می شود و یا زمان لود شدن صفحات را کاهش می دهد.