perlstyle - آنلاین در ابر

برنامه:

نام

پرل استایل - راهنمای سبک پرل

شرح

البته هر برنامه نویسی ترجیحات خود را در مورد قالب بندی خواهد داشت.
اما چند دستورالعمل کلی وجود دارد که خواندن برنامه های شما را آسان تر می کند،
درک کنید و حفظ کنید.

مهمترین چیز این است که برنامه های خود را تحت عنوان اجرا کنید -w پرچم در همه حال شما ممکن است
آن را به صراحت برای بخش های خاصی از کد از طریق پراگما "بدون هشدار" یا "بدون هشدار" خاموش کنید
متغیر $^W در صورت لزوم. شما همچنین باید همیشه تحت "استفاده سخت" اجرا کنید یا این را بدانید
دلیل اینکه چرا نه پراگماهای «استفاده از تله‌انداز» و حتی «استفاده از تشخیص‌ها» نیز ممکن است ثابت شود
مفید است

با توجه به زیبایی‌شناسی طرح‌بندی کد، تنها چیزی که لری به شدت به آن اهمیت می‌دهد این است
که براکت فرفری بسته شدن یک BLOCK چند خطی باید با کلمه کلیدی that ردیف شود
ساخت و ساز را آغاز کرد. فراتر از آن، او ترجیحات دیگری دارد که چندان قوی نیستند:

· تورفتگی 4 ستونی.

· باز کردن فرفری در همان خط به عنوان کلمه کلیدی، در صورت امکان، در غیر این صورت ردیف.

· فاصله قبل از فرفری باز یک BLOCK چند خطی.

· BLOCK یک خطی ممکن است روی یک خط قرار داده شود، از جمله فرفری ها.

· بدون فاصله قبل از نقطه ویرگول.

· نقطه ویرگول در BLOCK یک خطی "کوتاه" حذف شده است.

· فضای اطراف اکثر اپراتورها.

· فضای اطراف یک زیرنویس "پیچیده" (داخل پرانتز).

· خطوط خالی بین تکه هایی که کارهای مختلفی انجام می دهند.

· دیگران بی آغوش.

· بین نام تابع و پرانتز ابتدایی آن فاصله وجود ندارد.

· فاصله بعد از هر کاما.

· صف های طولانی شکسته پس از اپراتور (به جز "و" و "یا").

· فاصله بعد از تطبیق آخرین پرانتز در خط فعلی.

· اقلام مربوطه را به صورت عمودی ردیف کنید.

· تا زمانی که وضوح لطمه ای نداشته باشد، علائم نگارشی اضافی را حذف کنید.

لری برای هر یک از این چیزها دلایل خود را دارد، اما او ادعا نمی کند که دلایل دیگران است
ذهن مانند او کار می کند.

در اینجا چند موضوع سبک اساسی دیگر وجود دارد که باید در مورد آنها فکر کنید:

· فقط به این دلیل که شما CAN انجام کاری به روشی خاص به این معنی نیست که شما باید انجام دهید
از این طریق پرل به گونه ای طراحی شده است که چندین راه را برای انجام هر کاری به شما ارائه می دهد، پس در نظر بگیرید
انتخاب خواندنی ترین برای مثال

open(FOO,$foo) || die "نمی توان $foo: $ را باز کرد!";

از ... بهتر است

die "نمی توان $foo: $ را باز کرد!" مگر اینکه باز باشد (FOO,$foo);

زیرا راه دوم نکته اصلی عبارت را در یک اصلاح کننده پنهان می کند. در
دست دیگر

چاپ "شروع تجزیه و تحلیل\n" اگر $verbose;

از ... بهتر است

$verbose && چاپ "شروع تجزیه و تحلیل\n"؛

زیرا نکته اصلی این نیست که آیا کاربر تایپ کرده است یا خیر -v یا نه

به طور مشابه، فقط به این دلیل که یک اپراتور به شما اجازه می دهد آرگومان های پیش فرض را فرض کنید به این معنی نیست
که باید از پیش فرض ها استفاده کنید. پیش فرض ها برای سیستم های تنبل وجود دارد
برنامه نویسانی که برنامه های تک شات می نویسند. اگر می خواهید برنامه شما خوانا باشد،
ارائه استدلال را در نظر بگیرید.

در همین راستا، فقط به خاطر شما CAN حذف پرانتز در بسیاری از جاها نیست
به این معنی است که شما باید:

برگرداندن پرینت مرتب سازی معکوس num مقادیر %array;
بازگشت چاپ (معکوس (مرتب کردن تعداد (مقادیر (%آرایه))));

وقتی شک دارید، پرانتز کنید. حداقل اجازه خواهد داد که برخی از انحرافات ضعیف جهش کنند
روی کلید % در vi.

حتی اگر شک ندارید، به رفاه روانی فردی که مجبور است توجه کنید
کد را بعد از شما حفظ کنید و احتمالاً چه کسی پرانتزها را در جای اشتباه قرار می دهد.

· برای خروج از یک حلقه در بالا یا پایین، زمانی که پرل
اپراتور "آخرین" را ارائه می دهد تا بتوانید از وسط خارج شوید. فقط "بیگانه" آن را
کمی برای اینکه بیشتر قابل مشاهده باشد:

خط:
برای (؛؛) {
بیانیه؛
آخرین خط اگر $foo;
خط بعدی اگر /^#/;
بیانیه؛
}

· از استفاده از برچسب های حلقه نترسید - آنها برای افزایش خوانایی و همچنین
اجازه شکستن حلقه های چندسطحی را بدهید. مثال قبلی را ببینید.

· از استفاده از "grep()" (یا "map()") یا "backticks" در زمینه خالی خودداری کنید، یعنی زمانی که شما
فقط مقادیر برگشتی آنها را دور بریزید. همه این توابع دارای مقادیر بازگشتی هستند، بنابراین استفاده کنید
آنها در غیر این صورت از یک حلقه "foreach()" یا تابع "system()" به جای آن استفاده کنید.

· برای قابل حمل بودن، هنگام استفاده از ویژگی هایی که ممکن است در هر دستگاهی اجرا نشود،
ساختار را در یک eval تست کنید تا ببینید آیا شکست می خورد یا خیر. اگر می دانید چه نسخه ای یا
Patchlevel یک ویژگی خاص پیاده سازی شد، می توانید $] ($PERL_VERSION در
"انگلیسی") برای دیدن اینکه آیا آنجا خواهد بود یا خیر. ماژول "Config" نیز به شما اجازه می دهد
استعلام مقادیر تعیین شده توسط مجموعه برنامه زمانی که پرل نصب شد.

· شناسه های یادگاری را انتخاب کنید. اگر نمی توانید به یاد بیاورید که یادگاری به چه معناست، یک مشکل دارید
مشکل.

· در حالی که شناسه های کوتاه مانند $gotit احتمالاً خوب هستند، برای جدا کردن کلمات از زیرخط استفاده کنید
در شناسه های طولانی تر معمولا خواندن $var_names_like_this آسان تر از آن است
$VarNamesLikeThis، به ویژه برای افراد غیر بومی انگلیسی. این هم ساده است
قانونی که با "VAR_NAMES_LIKE_THIS" سازگار است.

گاهی اوقات نام بسته ها از این قاعده مستثنی است. پرل به طور غیر رسمی رزرو می کند
نام ماژول های حروف کوچک برای ماژول های "pragma" مانند "integer" و "strict". دیگر
ماژول ها باید با حروف بزرگ شروع شوند و از حروف مختلط استفاده کنند، اما احتمالاً بدون آن
به دلیل محدودیت در نمایش ماژول های سیستم های فایل ابتدایی تاکید می کند
نام ها به عنوان فایل هایی که باید در چند بایت پراکنده قرار گیرند.

· ممکن است استفاده از حروف بزرگ برای نشان دادن دامنه یا ماهیت a مفید باشد
متغیر. مثلا:

فقط ثابت‌های $ALL_CAPS_HERE (مراقب برخورد با perl vars باشید!)
$Some_Caps_Here بسته جهانی/ایستا
$no_caps_here محدوده تابع my() یا local() متغیر

به نظر می رسد نام توابع و روش مانند همه حروف کوچک بهتر عمل می کند. به عنوان مثال،
"$obj->as_string()".

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

· اگر یک عبارت منظم واقعاً مودار دارید، از اصلاح کننده "/x" استفاده کنید و مقداری را وارد کنید
فضای خالی را ایجاد کنید تا کمی کمتر شبیه نویز خط به نظر برسد. از اسلش به عنوان علامت استفاده نکنید
زمانی که regexp شما دارای اسلش یا بک اسلش است، جداکننده.

· از عملگرهای جدید «و» و «یا» استفاده کنید تا از پرانتز کردن عملگرهای فهرست اجتناب کنید
بسیار، و برای کاهش بروز عملگرهای نقطه گذاری مانند "&&" و "||". صدا زدن
برای جلوگیری از زیاده‌روی، زیربرنامه‌های خود را به‌گونه‌ای عمل می‌کنید که گویی توابع یا عملگرهای فهرست هستند
علامت و پرانتز.

· در اینجا از اسناد به جای عبارات تکراری "print()" استفاده کنید.

· چیزهای مربوطه را به صورت عمودی ردیف کنید، به خصوص اگر خیلی طولانی باشد که روی یکی قرار نگیرد
به هر حال خط

$IDX = $ST_MTIME;
$IDX = $ST_ATIME اگر $opt_u;
$IDX = $ST_CTIME اگر $opt_c;
$IDX = $ST_SIZE اگر $opt_s;

mkdir $tmpdir، 0700 یا die "نمی توان mkdir $tmpdir: $!";
chdir($tmpdir) یا die "can't chdir $tmpdir: $!";
mkdir 'tmp'، 0777 یا die "can't mkdir $tmpdir/tmp: $!";

· همیشه کدهای برگشتی تماس های سیستمی را بررسی کنید. پیام های خطای خوب باید به
"STDERR"، شامل برنامه ای که باعث ایجاد مشکل شده است، سیستم ناموفق چه تماسی می گیرد و
آرگومان ها بودند، و (بسیار مهم) باید حاوی پیام خطای استاندارد سیستم باشند
برای آنچه اشتباه شد در اینجا یک مثال ساده اما کافی آورده شده است:

opendir(D, $dir) یا die "can't opendir $dir: $!";

نویسه های خود را در صورت منطقی ردیف کنید:

tr [abc]
[xyz]؛

· به قابلیت استفاده مجدد فکر کنید. چرا قدرت مغز را روی یک ضربه تلف کنید در حالی که ممکن است بخواهید این کار را انجام دهید
دوباره چیزی شبیه آن؟ تعمیم کد خود را در نظر بگیرید. نوشتن یک ماژول را در نظر بگیرید
یا کلاس شی در نظر داشته باشید که کد خود را با استفاده از گزینه های "use strict" و "use" به طور تمیز اجرا کنید
هشدارها" (یا -w) در اثر. در نظر بگیرید که کد خود را ارائه دهید. تغییر خود را در نظر بگیرید
کل جهان بینی در نظر بگیرید... اوه، مهم نیست.

· سعی کنید کد خود را مستند کنید و از قالب بندی Pod به روشی ثابت استفاده کنید. اینجا هستند
کنوانسیون های معمول مورد انتظار:

· از "C<>" برای نام توابع، متغیرها و ماژول ها (و به طور کلی هر چیزی) استفاده کنید
که می تواند بخشی از کد در نظر گرفته شود، مانند filehandles یا مقادیر خاص). توجه داشته باشید
که نام توابع با پرانتز بعد از آنها قابل خواندن تر در نظر گرفته می شوند
نام، که "function()" است.

· از "B<>" برای نام دستوراتی مانند استفاده کنید گربه or grep استفاده.

· از "F<>" یا "C<>" برای نام فایل ها استفاده کنید. "F<>" باید تنها کد پاد برای فایل باشد
نام‌ها، اما همانطور که اکثر فرمت‌کننده‌های Pod آن را به صورت ایتالیک، مسیرهای یونیکس و ویندوز با آن ارائه می‌کنند
اسلش‌ها و اسلش‌های آنها ممکن است کمتر خوانا باشند و بهتر رندر شوند
"C<>".

· مقاوم باش.

· خوب باش.

با استفاده از خدمات onworks.net به صورت آنلاین از perlstyle استفاده کنید