9 mẹo để viết code sạch, code đẹp

Tôi đã viết code được 20 năm. Trong thời gian đó, tôi đã làm việc với 17 nhóm phát triển các ngôn ngữ khác nhau để xây dựng hàng trăm dự án. Chúng bao gồm tất cả mọi thứ từ một trang blog đơn giản, tới các API hỗ trợ 3.000 request /giây, đến các ứng dụng bán chạy nhất.

Từ những kinh nghiệm này, tôi tin rằng điều quan trọng nhất của code: chính là việc nó dễ đọc.

Đây là một điều mà rất nhiều developer vẫn còn xem nhẹ hoặc không quan tâm tới. Thật đáng tiếc, bởi việc code dễ đọc thật sự sẽ thay đổi và ảnh hưởng tới mọi thứ trong project của bạn. Trong bài viết này, tôi sẽ liệt ra 9 cách giúp cho bạn viết code rõ ràng và dễ đọc hơn.

Phân vân trong việc chọn Format

Quá nhiều thứ bị lãng phí khi bạn cứ mãi suy nghĩ về format. Đó là một cuộc tranh cãi không bao giờ ngừng giữa Tab vs Space. Hay Allman so với K & R. Thay vào đó, hãy áp dụng một định dạng tiêu chuẩn cho codebase và tự động hóa nó. Sau đó, bạn có thể tập trung năng lượng đó vào quá trình viết code.

Code chết

Tất cả các commented block, biến không sử dụng và mã không thể truy cập đều được xem như đã “chết”. Theo thời gian, chúng sẽ giết chết codebase của bạn vì vậy mà ta phải tìm kiếm và tiêu diệt code chết. Trong khi nó không cần phải là trọng tâm chính của bạn, luôn luôn là một Hướng đạo sinh.

Code nặng nề

Nền tảng của gần như tất cả các code là logic. Chúng ta viết code để đưa ra quyết định và tính toán. Điều này thường dẫn đến các nhánh hoặc vòng lặp tạo ra các khối code đan chéo và lồng vào nhau. Như vậy, nó khiến code bị phức tạp và không đọc được. Bạn có thể giải quyết vấn đề này với return, guard clause hoặc các tính năng của functional programming.

Sử dụng objects

Mặc dù đây là thời đại của lập trình hướng đối tượng, các dev vẫn viết code rất xấu với những tham số dài ngoằn, cụm dữ liệu và cấu trúc mảng / từ điển tùy chỉnh. Tuy vậy, chúng có thể được tái cấu trúc thành các object. Nhờ đó mà giúp đồng nhất cấu trúc hóa của dữ liệu.

Những đoạn code quá dài

Khi bạn xác định rằng có những đoạn code quá dài thì hãy ngay lập tức recognize, regroup, và refactor nó. Quy trình đơn giản này cho phép bạn xác định bối cảnh và mức độ phức tạp của đoạn code để bạn có thể tái cấu trúc lại cho dễ đọc và ít phức tạp hơn.

Đặt tên

Chắc chắn, đặt tên luôn là một việc khó khăn. Nhưng đó là vì chúng ta tự làm cho nó phức tạp hơn cần thiết. Có một mẹo nhỏ hoạt động tốt với nhiều thứ trong lập trình, bao gồm đặt tên. Đó là đừng bao giờ để mình bị mắc kẹt chỉ vì phải suy nghĩ đặt tên một cái gì đó. Thay vào đó, bạn hãy tiếp tục viết code. Đặt một cái tên thật rõ ràng và đơn giản và dồn hết thời gian chăm sóc cho đoạn code sẽ thiết thực hơn.

Bỏ bớt comment

Đừng viết code mà bạn phải liên tục phải giải thích, thay vào đó, hãy cố gắng viết những đoạn code dễ hiểu và cần càng ít comment để giải thích càng tốt. Như vậy, khả năng viết của bạn sẽ ngày càng được cải thiện.

Sử dụng Return hợp lí

Bạn nên cố gắng return một giá trị hợp lý thay vì Null. Lý tưởng nhất là một cái gì đó cho phép code gọi để thực hiện ngay cả trong trường hợp của một giá trị bị âm. Nếu có trường hợp thực sự đặc biệt, thì bạn vẫn có những cách tốt hơn để xử lí với chúng hơn là null.

Symmetry – Tính đối xứng

Đối xứng thể hiện mặt sáng tạo của văn bản. Nó là nền tảng của nhiều thực hành khác: naming, structure, objects, pattern. Nó có thể thay đổi tùy theo ngôn ngữ, codebase và nhóm phát triển. Tuy nhiên, một khi bạn bắt đầu áp dụng tính đối xứng vào mã của bạn, mọi thứ sẽ trở nên rõ ràng và dễ hiểu hơn rất nhiều.

Techtalk via dev.to