آموزش کد پاک: کد نوشتن برای انسان ها

سرفصل ها و درس ها

معرفی Introduction

• معرفی Introduction

• چرا باید اهمیت بدهم؟ Why should I care?

• بنیاد The Foundation

• ما نویسنده هستیم We are Authors

• کنوانسیون ها Conventions

• منابع Resources

اصول Principles

• سه اصل اصلی Three Core Principles

• ابزار مناسب برای کار The Right Tool for The Job

• مرزها مهم هستند: بومی بمانید Boundaries Matter: Stay Native

• شر بالقوه Potential Evil

• نسبت سیگنال به نویز Signal to Noise Ratio

• اصل DRY DRY Principle

• کد خود مستندسازی Self-documenting Code

• خلاصه Summary

نامگذاری Naming

• معرفی Introduction

• مسائل نامگذاری Naming Matters

• کلاس ها Classes

• مواد و روش ها Methods

• اردک لاستیکی Rubber Ducking

• علائم هشدار دهنده Warning Signs

• اثرات جانبی Side Effects

• اختصارات Abbreviations

• بولین ها Booleans

• تقارن Symmetry

• خلاصه Summary

شرایط Conditionals

• معرفی Introduction

• مقایسه های بولی Boolean Comparisons

• تکالیف بولی Boolean Assignments

• شرایط مثبت Positive Conditionals

• ظرافت سه تایی Ternary Elegance

• به صورت رشته ای تایپ شده است Stringly Typed

• اعداد جادویی Magic Numbers

• شرایط پیچیده Complex Conditionals

• چند شکلی در مقابل Enums Polymorphism vs Enums

• اظهاری باشد Be Declarative

• روش های جدول محور Table Driven Methods

• خلاصه Summary

کارکرد Functions

• مقدمه Intro

• زمان ایجاد یک تابع When to Create A Function

• از تکراری شدن بپرهیزید Avoid Duplication

• نمای کلی تورفتگی بیش از حد Excessive Indentation Overview

• روش استخراج Extract Method

• زودتر برگرد Return Early

• شکست سریع Fail Fast

• نیت را منتقل کنید Convey Intent

• یک چیز را انجام دهید Do One Thing

• متغیرهای Mayfly Mayfly Variables

• مولفه های Parameters

• چه چیزی خیلی طولانی است؟ What's Too Long?

• استثناها Exceptions

• خلاصه Summary

کلاس ها Classes

• مقدمه Intro

• چه زمانی ایجاد شود When to Create

• انسجام Cohesion

• چه زمانی کلاس A خیلی کوچک است؟ When is A Class too Small?

• وسواس اولیه Primitive Obsession

• اصل مجاورت Principle of Proximity

• قانون طرح کلی Outline Rule

• خلاصه Summary

نظرات Comments

• معرفی Introduction

• ضرورت و عصا Necessity and Crutch

• زائد Redundant

• قصد Intent

• عذرخواهی و هشدار Apologies and Warnings

• کد زامبی Zombie Code

• تقسیم کننده ها و بریس ردیاب ها Dividers and Brace Trackers

• هدر پف کرده Bloated Header

• گزارش نقص Defect Log

• نظرات پاک Clean Comments

• خلاصه Summary

نسخه ی نمایشی Demo

• معرفی Introduction

• بررسی اجمالی ثبت نام Registration Overview

• معیارهای کد Code Metrics

• تست های خودکار Automated Tests

• نظرات Comments

• متغیرهای Mayfly Mayfly Variables

• بند نگهبانی Guard Clause

• مسائل نامگذاری Naming Issues

• بازگشت زودهنگام Returning Early

• Refactor Red Flags Refactor Red Flags

• نگهبانان را تثبیت کنید و هدف را روشن کنید Consolidate Guards and Clarify Intent

• جدول رانده روش و شکست سریع Table Driven Method and Fail Fast

• قانون طرح کلی Outline Rule

• آزمون رگرسیون Regression Test

• رفع اشکال: چه کنتراست! Bug Fixes: What a contrast!

• نتایج و نتیجه گیری های متریک کد Code Metric Results and Conclusions

تمیز بمان Stay Clean

• زمان Refactor When to Refactor

• ویندوز شکسته Broken Windows

• بررسی کد و برنامه نویسی جفت Code Reviews & Pair Programming

• قانون پیشاهنگی پسر Boy Scout Rule

• نتیجه Conclusion