10 نکته برای نوشتن کد تمیز و خوانا

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

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

از نام متغیرها و توابع معنی دار استفاده کنید

یکی از مهمترین جنبه های نوشتن کدهای تمیز و خوانا، استفاده از نام متغیرها و توابع معنی دار است. هنگام نام‌گذاری متغیرها، مهم است که نام‌هایی را انتخاب کنید که دقیقاً آنچه را که متغیر نشان می‌دهد توصیف کند. از استفاده از حروف یا حروف اختصاری که به راحتی قابل تشخیص نیستند خودداری کنید. به عنوان مثال، به جای استفاده از “x” یا “temp”، از “current_x_coordinate” یا “temporary_result” استفاده کنید.

به همین ترتیب، نام توابع باید توصیفی باشد و به وضوح نشان دهد که تابع چه کاری انجام می دهد. به عنوان مثال، به جای استفاده از “calc”، از “calculate_result” استفاده کنید. با استفاده از نام متغیرها و توابع معنی دار، درک کد شما و زمانی که بعد از مدتی به آن بازگردید را برای توسعه دهندگان دیگر آسان تر می کنید.

همچنین استفاده از قرارداد نامگذاری یکسان در سراسر کد خود برای سازگارتر و خواندن آسان تر، تمرین خوبی است.

استفاده از نام متغیرها و توابع معنی دار می تواند تفاوت زیادی در خوانایی و قابلیت نگهداری کد شما ایجاد کند و یک نکته ساده و در عین حال موثر برای نوشتن کدهای تمیز و خوانا است.

عملکردهای خود را کوچک و متمرکز نگه دارید

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

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

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

علاوه بر این، همچنین ایده خوبی است که تابع را کوتاه و ساده نگه دارید، تعداد خطوط کد را در داخل یک تابع محدود کنید و در صورت امکان از کمتر از 10 خط استفاده کنید.

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

از تورفتگی و فاصله مناسب استفاده کنید

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

استفاده از تورفتگی ثابت نیز مهم است. چه استفاده از برگه‌ها یا فاصله‌ها را انتخاب کنید، مهم است که در سراسر کد خود یکدست باشید. با این کار کد شما خواناتر و قابل فهم تر می شود.

فاصله گذاری نیز نقش مهمی در خوانایی بیشتر کد شما دارد. با افزودن فاصله بین عملگرها، کلمات کلیدی و سایر عناصر، می توانید کد خود را برای خواندن و درک آسان تر کنید. به عنوان مثال، به جای نوشتن “x=5+y*6” نوشتن “x = 5 + y * 6” خواناتر است.

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

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

کد خود را کامنت کنید

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

هنگام کامنت کردن کد خود، مهم است که واضح و مختصر باشد. از استفاده از زبان بیش از حد فنی خودداری کنید و در عوض از زبان ساده و قابل فهم استفاده کنید. همچنین نظرات باید به گونه ای نوشته شوند که “چرا” و نه تنها “چه” کد را توضیح دهند.

همچنین استفاده از یک سبک نظر دهی ثابت در سرتاسر کدتان تمرین خوبی است. این کار باعث می‌شود تا زمانی که بعد از مدتی دوباره به کد شما برمی‌گردید، دیگر توسعه‌دهندگان بتوانند کد شما را درک کنند.

همچنین استفاده کم از نظرات بسیار مهم است. استفاده بیش از حد از نظرات می تواند خواندن کد شما را سخت تر و درک آن را سخت تر کند. همیشه بهتر است کدی تمیز و خوانا بنویسید، که خود توضیحی است، و سپس از نظرات فقط برای توضیح پیچیده ترین بخش های کد استفاده کنید.

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

از استفاده از متغیرهای سراسری خودداری کنید

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

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

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

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

از قراردادهای نامگذاری ثابت استفاده کنید

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

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

همچنین مهم است که در قراردادهای نامگذاری خود در سراسر کد خود ثابت باشید. این به معنای استفاده از قراردادهای نامگذاری یکسان برای متغیرها، توابع، کلاس‌ها و عناصر دیگر و استفاده مداوم از آنها در بخش‌های مختلف کدتان است.

همچنین استفاده از نام‌های توصیفی که معنی و کاربرد متغیرها، توابع، کلاس‌ها و عناصر دیگر را بیان می‌کنند، مهم است. این کار باعث می‌شود تا زمانی که بعد از مدتی دوباره به کد شما برمی‌گردید، دیگر توسعه‌دهندگان بتوانند کد شما را درک کنند.

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

کدهای پیچیده را به تکه های کوچکتر تقسیم کنید

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

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

راه دیگر برای تجزیه کدهای پیچیده استفاده از کلاس ها یا ماژول ها است. از کلاس‌ها و ماژول‌ها می‌توان برای گروه‌بندی توابع و داده‌های مرتبط با هم استفاده کرد و سازمان‌دهی و درک کد شما را آسان‌تر می‌کند.

علاوه بر این، می‌توانید از دستورات جریان کنترلی مانند if-else و for-loops استفاده کنید تا کدهای پیچیده را به تکه‌های کوچک‌تر تقسیم کنید و آن را خواناتر و قابل درک‌تر کنید.

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

از استفاده از اعداد جادویی خودداری کنید

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

یکی از راه‌های اجتناب از استفاده از اعداد جادویی، استفاده از ثابت‌های نام‌گذاری شده به جای آن است. ثابت های نامگذاری شده متغیرهایی هستند که یک نام و یک مقدار داده می شوند و به جای اعداد جادویی استفاده می شوند. این نشان می دهد که این عدد چه چیزی را نشان می دهد و چرا از آن استفاده می شود.

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

علاوه بر این، می توانید از نظرات برای توضیح هدف اعداد جادویی استفاده شده در کد استفاده کنید.

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

از استفاده از مقادیر رمزگذاری شده خودداری کنید

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

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

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

با اجتناب از استفاده از مقادیر رمزگذاری شده، درک، آزمایش و نگهداری کد خود را آسان‌تر می‌کنید. این باعث صرفه جویی در زمان و تلاش شما در دراز مدت می شود و کد شما را قوی تر و کمتر در معرض خطا قرار می دهد. همچنین به شما این امکان را می دهد که تغییرات را به راحتی انجام دهید و محیط های مختلف مانند توسعه، آزمایش و تولید را با مقادیر متفاوت مدیریت کنید.

کد خود را به طور منظم تست کنید

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

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

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

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

کد تمیز

کد تمیز کدی است که خواندن، درک و نگهداری آن آسان است. این از بهترین شیوه ها و قراردادها پیروی می کند و به گونه ای نوشته شده است که درک منطق و هدف پشت کد را آسان می کند. کد تمیز به خوبی سازماندهی شده است و ساختاری واضح دارد و از نام متغیرها و توابع معنی دار استفاده می کند. همچنین به خوبی با نظرات مستند شده است، و دارای سبک ثابت و قراردادهای نامگذاری است.

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

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

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

نمونه های کد تمیز

در اینجا یک مثال از کد تمیز در پایتون آمده است:

def calculate_area(length, width):
    """Calculate the area of a rectangle"""
    area = length * width
    return area

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

مطلب پیشنهادی:کار با داده ها در پایتون

در اینجا یک مثال دیگر در جاوا آورده شده است:

public class Employee {
    private String name;
    private int age;

    public Employee(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public int getAge() {
        return age;
    }
}

این کلاس از تورفتگی و فاصله مناسب و قراردادهای نام‌گذاری سازگار با camelCase برای نام متغیرها و توابع استفاده می‌کند. همچنین ساختار واضحی دارد و درک و استفاده از کلاس آسان است.

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

اصول کد تمیز

در اینجا برخی از اصول کد تمیز آورده شده است:

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

نوشتن کتاب کد تمیز

“Clean Code: A Handbook of Agile Software Craftsmanship” کتابی نوشته رابرت سی مارتین است که با نام عمو باب نیز شناخته می شود. این کتاب راهنمای نوشتن کدهای تمیز و خوانا است و بهترین شیوه ها و اصول کاردستی نرم افزار را پوشش می دهد. کتاب به سه بخش تقسیم شده است، بخش اول اصول، الگوها و شیوه های نوشتن کد تمیز را پوشش می دهد، بخش دوم شامل چندین مطالعه موردی با پیچیدگی فزاینده است، و بخش سوم فهرستی از اکتشافات و “بوی ها” جمع آوری شده است. در حین ایجاد مطالعات موردی

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

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

نحوه نوشتن کد تمیز در جاوا اسکریپت

نوشتن کدهای تمیز در جاوا اسکریپت شامل بهترین شیوه ها و قراردادهای زیر است، مانند:

• خوانایی: از نام متغیرها و توابع معنی دار، تورفتگی و فاصله مناسب و قراردادهای نامگذاری ثابت استفاده کنید.
• سادگی: از پیچیدگی و کدهای غیر ضروری اجتناب کنید، عملکردها را کوچک و متمرکز نگه دارید و کدهای پیچیده را به قطعات کوچکتر تقسیم کنید.
• ماژولاریت: از ماژول ها و کلاس ها برای سازماندهی کد خود و کپسوله کردن عملکردهای مرتبط استفاده کنید.
• Declarative: از تکنیک های برنامه نویسی declarative به جای دستورات استفاده کنید.
• از انواع داده های مناسب استفاده کنید: از انواع داده های صحیح برای متغیرها استفاده کنید و از ویژگی چک کردن نوع جاوا اسکریپت استفاده کنید.
• از متغیرهای غیرضروری جهانی اجتناب کنید: از بسته‌ها، IIFE یا ماژول‌ها برای جلوگیری از آلوده کردن دامنه جهانی استفاده کنید.
• استفاده از نظرات: از نظرات برای توضیح هدف و منطق پشت کد خود استفاده کنید.
• کد خود را آزمایش کنید: تست های واحد خودکار را برای کد خود بنویسید تا مطمئن شوید که مطابق انتظار کار می کند.
• استفاده از linter: از ابزار linter برای بررسی کد خود برای خطاها و اطمینان از سازگاری در سبک کدنویسی استفاده کنید.

مطلب پیشنهادی:مزایای استفاده از جاوا اسکریپت در توسعه وب

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

در اینجا یک مثال از کد تمیز در جاوا اسکریپت آمده است:

function calculateArea(length, width) {
    //calculate the area of a rectangle
    return length * width;
}

این تابع از نام متغیرها و توابع واضح و معنی دار استفاده می کند و به راحتی می توان منطق پشت آن را درک کرد. کوچک، متمرکز و آزمایش آن آسان است.

در اینجا یک مثال دیگر در جاوا اسکریپت آورده شده است:

class Employee {
    constructor(name, age) {
        this.name = name;
        this.age = age;
    }

    getName() {
        return this.name;
    }

    getAge() {
        return this.age;
    }
}

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

توجه به این نکته ضروری است که کد تمیز به مثال های بالا محدود نمی شود، پروژه های مختلف نیازهای متفاوتی دارند و اصول کد تمیز باید بر اساس آن ها تطبیق داده شود، اما با پیروی از بهترین روش ها و اصول، در مسیر درستی قرار خواهید گرفت. برای نوشتن کدهای تمیز و خوانا در جاوا اسکریپت.

جمع بندی و نتیجه

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

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

در نتیجه، نوشتن کد تمیز مستلزم پیروی از بهترین روش‌ها و اصول است، و تسلط بر آن زمان و تلاش می‌برد، اما در درازمدت مزایایی را به همراه خواهد داشت، زیرا کد شما را قوی‌تر، کمتر مستعد خطا و نگهداری آسان‌تر می‌کند. علاوه بر این، همکاری با توسعه دهندگان دیگر را آسان تر می کند و روند توسعه را کارآمدتر و لذت بخش تر می کند.