بهترین شیوه کد نویسی ( Best Coding Practice )
در این مقاله قصد دارم نکاتی که باعث می شود شما بهترین شیوه و سبک کد نویسی را در پروژه ها و سورس کد ها خود پیاده سازی کنید را بیان کنم.
همیشه اولین چیزی که در کد به چشم می آید مرتب بودن ساختار و نامگذاری ها و کامنت گذاری ها وغیره در سورس پروژه شما می باشد. لذا هر چه کد شما مرتب و استاندارد تر باشد باعث می شود بهتر ارایه دهید و در ضمن آن را به دیگران انتقال دهید، برای همین اکثر شرکت ها برنامه نویسانی که این اصول را رعایت می کنند را بهتر ترجیح می دهند.
مثلا در PHP قوانین برای این امر تعریف شده است به نام PSR که می توانید با کلیک کردن بر روی آن مستندات آن را مشاهده کنید.
من مخزنی را بر روی GitHub به شما معرفی میکنم که کد خوب و کد بد را در زبان JavaScript باهم مقایسه کرده است .
https://github.com/rezasaleki/clean-code-javascriptکتاب های متعددی هم در این زمینه وجود دارد که من میتوانم به یکی از معروف ترین ها که توسط Robert C.Martin نوشته شده است به نام The Clean Code اشاره کنم .
از تمام این صحبت ها میخواستم بگم که بدانید چقد اهمیت این قضیه بالا می باشد تا نکات زیر را برای هرچه بهتر نوشتن کد هایتان بیان کنم .
۱. همیشه متغییر ها و توابع خود را با نهایت دقت سعی کنید نام گذاری کنید و بطور کامل توضیح دهید.
۲. اسنادی برای سناریو فنی خود بسازید، حتی اگر مختصر یا توصیفی باشند.
۳. کدی که اجرا می شود کمتر از زمان خواندن آن وقت میگیرد پس سعی کنید همیشه برای شفافیت آن بیشتر زمان صرف کنید.
۴. هر تابعی که تعریف می کنید باید یک کار را انجام دهد ولی به درستی، این اصل به طراحی الگو یا Design Pattern و قوانین SOLID اشاره می کند که یک بند در آن به نام Single Responsibility Principle اشاره دارد.
۵. هر تابع باید به صورت Black Box عمل کند به این معنی که اگر کسی تابع شما را می بیند فقط از نام تابع متوجه فرایند آن شود و نیازی نباشد به بدنه آن سر بزند و از آن خبر داشته باشد.
۶. تا می توانید در سورس کد های خود از تعریف متغییر های سراسری امتناع کنید و آن ها را متصل به بلاک های خود نگهدارید.
۷. سعی کنید برای کد های خود علاوه بر تست های انسانی تست های سیستمی بنویسید که به عنوان مثال میتوانید در JavaScript به JestJS مراجعه کنید و برای PHP به PHPUnit مراجه کنید.
۸.شما هیچ وقت نمیتوانید 100% صحت کدی را که نوشته اید را تضمین کنید ولی با تست گرفتن و آزمون و خطا کردن می توانید تا حدی بالایی جلوی خطا های احتمالی را بگیرید.
۹. هرگاه در در برنامه ی به مشکلی می خورید یا میخواهید مشکلی را حل کنید حتما قبل از نوشتن کد در مورد آن فکر و تحقیق کنید تا کاملا نحو حل کردن آن را درک کنید.
۱۰. در صورت بروز مشکل اولین اقدامی که می کنید مشکل را به قطعات کوچک تر تقسیم کنید و بعد هر قسمت را به صورت جدا برسی و حل کنید، یکی از موارد که می توان به آن اشاره کرد همین ساختارمند و استاندارد بودن کد هایتان است که اینجا به طور چشمگیری به شما کمک می کند.
۱۱. تا میتوانید توابع خود را به توابع کوچکتر بشکنید و وظایف آن ها را تا حدالممکن ساده تعریف کنید.
۱۲. برنامه خود را برای دیگران توضیح دهید این امر به شما کمک میکند خودتان بهتر آن را درک کنید.
۱۳. از VCS ها از قبیل Git در برنامه خود استفاده کنید تا تغییرات را در برنامه های شما همیشه دنبال کند و کارهای گروهی شما را سازماندهی کند.
نتیجه گیری
شاید موارد دیگ هم باشد که بتوانید خودتان ذکر کنید ولی من قصدم فقط باز کردن اهمیت کد نویسی تمیز و رعایت استاندارد ها و الگو های که به ساختار برنامه های شما نظم می دهد است، امیدوارم این مقاله برای شما مفید باشد.
موارد ذکر شده در بالا از کتاب های کد نویسی تمیز و Data Structures and Program Design in C می باشد.