9 tip giúp bạn viết code “ngon nghẻ” hơn

Viết mã rõ ràng là 1 nhiệm vụ bậc nhất nếu bạn là 1 nhà tăng trưởng ứng dụng. Tuy nhiên, bạn đã bao giờ nghĩ rằng mã của bạn thực thụ tốt?

Giữ cho code “sạch”, rõ ràng và dễ đọc là 1 lề thói tốt nhưng mà không hề lập trình viên nào cũng ân cần. Thật đáng tiếc, vì code thực thụ sạch bóng chỉnh sửa và tác động tới nhiều thứ trong dự án của bạn.

Vậy Clean Code – Mã sạch là gì?

Clean Code hiểu nôm na nghĩa là mã sạch, mã rõ ràng, dễ đọc.

Mã sạch Rõ ràng có tức là mã sạch, mã rõ ràng, dễ đọc.

Về vẻ ngoài, Clean Code trình bày như sau:

  • Cách thể hiện mã: cách căn lề, thụt lề sử dụng các tab, dấu cách … sao cho dễ đọc, đã mắt.
  • Cách đặt tên biến, hàm, lớp theo nguyên lý chung lúc lập trình?
  • Cách cung ứng số lượng mã (số dòng mã trong 1 tệp, số dòng mã trong 1 phương thức …)

Về những điều cần phê chuẩn:

  • Cách đặt tên hàm, tên biến phải dễ đọc, dễ hiểu.
  • Xác định thời khắc nhận xét về mã và lúc nào thì ko.
  • Thiết kế và xây dựng cấu trúc nhân vật dữ liệu (Object) dễ sử dụng và mở mang.
  • Thiết kế cách xử lý ngoại lệ (Exception) cân đối.
  • Khả năng bảo trì và bản lĩnh mở mang của mã có tốt ko?

Nghe thì có vẻ dễ dàng nhưng mà không phải dễ dãi chút nào.

Vì thế, với bài viết này, Phần Mềm Portable VN sẽ liệt kê ra 9 mẹo giúp bạn viết mã “sạch và tốt hơn”. Mời độc giả theo dõi!

Đặt tên có ý nghĩa

Làm cho tên biến, tên hàm, tên lớp ... có ý nghĩa

Nhân vật, biến, lớp, hàm tức là gì? Có rất nhiều khái niệm học thuật về những định nghĩa này, nhưng mà lúc bạn nghĩ về chúng 1 cách toàn cục, có thể nói rằng đây là mối liên hệ giữa các lập trình viên và logic căn bản của phần mềm nhưng họ đang viết.

Nếu bạn sử dụng tên mập mờ, ko miêu tả các biến, lớp, hàm căn bản, thì bạn đang tự “giấu” logic phần mềm và tự làm khó mình nếu cần cập nhật và cập nhật sau. biên tập phần mềm. Điều này cũng dẫn các đồng nghiệp sẽ đọc mã của bạn sau này vào 1 mê cung ko có nơi nào để đi.

“Tôi không hề là 1 lập trình viên giỏi; Tôi chỉ là 1 lập trình viên giỏi với những lề thói xuất sắc ”. – Kent Beck

Biến có tên abc có tức là gì? Hãy xoành xoạch! Bạn có thể sẽ cần phải đọc lại toàn thể mã để hiểu abc có tức là gì !? Khái quát, đọc mã như thế này sẽ vô cùng gieo neo. Thay vì muốn đại diện cho danh sách người mua bằng biến list1, sử dụng listCustomer. Tại vì list1 là 1 cái tên bất nghĩa dễ gây lầm lẫn và khó hiểu lúc đọc. Điều này cũng đúng với việc đặt tên cho các lớp hoặc hàm.

Vì thế, tóm lại, 1 tên biến đạt đề xuất phải giải đáp được 3 câu hỏi phệ:

  • CÁI GÌ: Nó là gì?
  • TẠI SAO: Cái này được dùng để làm gì?
  • LÀM SAO: Làm thế nào để sử dụng nó?

Dành thêm vài giây để nghĩ ra 1 cái tên hay, tiết kiệm hàng giờ sau đấy.

Các hàm và lớp phải ngắn gọn và làm được 1 việc

Bạn đã bao giờ gặp 1 hàm dài hàng trăm, thậm chí hàng ngàn dòng chưa? Nếu vậy, bạn có thể hình dung sẽ đớn đau như thế nào nếu chúng ta phải duyệt, đọc hoặc sửa đổi các tính năng tương tự. Nhận xét có thể sẽ giúp ích 1 chút, nhưng mà chỉ ở 1 chừng độ rất giảm thiểu.

Vì thế, hàm nên càng ngắn càng tốt. 1 hàm lý tưởng ko được nhiều hơn 20 dòng. Về nguyên lý, nếu 1 hàm quá dài, hãy chia nó thành các hàm con, mỗi hàm làm 1 việc độc nhất. Tên của hàm phải nêu rõ tính năng duy nhất của nó.

Thí dụ 1 hàm phức tạp như GetCreditScore () có thể được phân thành nhiều tính năng viện trợ bé hơn của loại GetCreditReports (), ApplyCreditHistoryAge ()FilterOut StandingMarks ()…

Xóa mã ko thiết yếu

Thói quen xấu giữ một số mã thừa là một trong những điều mà mọi lập trình viên phải trải qua

Thói quen xấu là giữ 1 số mã thừa là 1 trong những điều nhưng mọi lập trình viên phải trải qua. Chắc chắn bạn sẽ không xa lạ với cảnh huống này: bạn muốn sửa hoặc tối ưu hóa 1 đoạn mã, nhưng mà sau lúc bạn nhận xét và viết 1 đoạn mã mới – và dù rằng nó hoạt động, bạn vẫn giữ đoạn mã cũ. đằng kia.

Theo thời kì, những nhận xét đấy ko còn thiết yếu nữa và sẽ khiến cho tệp nguồn của bạn phát triển thành bừa bãi. Do đấy, lúc có 1 đoạn mã thừa, có hoặc ko, chúng ta cần loại trừ nó khỏi mã nguồn để giúp phần mềm của bạn sạch hơn.

Tránh rút ngắn mã quá mức

Có rất nhiều lập trình viên muốn liên kết mã sạch – mã sạch với mã sáng dạ – mã sáng dạ, chả hạn như thống nhất 10 dòng thành 1 bằng cách nào đấy khiến cho nó trông ngăn nắp hơn. Điều này vững chắc sẽ giúp mã chiếm ít ko gian hơn trên màn hình, nhưng mà nó có thực thụ dễ hiểu?

Câu giải đáp là đôi lúc nó có thể, nhưng mà phần phệ nó ko dễ hiểu chút nào!

Thông thường, viết code “sáng dạ” thường là để trình bày cái tôi tư nhân, hoặc ngầm trình bày rằng “não tôi sáng dạ nên tôi mới nghĩ được tương tự”. Cũng có trường hợp người viết ham thích với thách thức tạo ra sự dị biệt, nhưng mà lại vô tình khiến người đọc khó hiểu đoạn mã sau đấy.

Vì thế, để viết mã sạch, hãy đặt cái tôi của bạn đằng sau, tối ưu hóa mã để ngay cả những người tiếp theo làm việc với phần mềm cũng có thể hiểu được. Ngay cả sau 1 thời kì, người sử dụng mã này vẫn là bạn và bạn ko nhớ các phím tắt được sử dụng trong mã ngắn này của bạn có tức là gì, điều đấy hoàn toàn có thể xảy ra! Không lạ nếu bạn nói rằng bạn chẳng thể hiểu những gì bạn đã làm?

Chọn kiến ​​trúc thích hợp cho dự án

Có rất nhiều mô hình và kiến ​​trúc khác nhau mà bạn có thể sử dụng để tạo ra dự án của mình.

Có rất nhiều mẫu hình và kiến ​​trúc không giống nhau nhưng bạn có thể sử dụng để phục vụ dự án của mình. Nhưng hãy luôn nhớ rằng đấy là việc chọn lựa kiến ​​trúc thích hợp với nhu cầu của bạn, chứ không hề chọn 1 trong những kiến ​​trúc tốt nhất.

Thí dụ:

  • Mẫu hình Model-View-Controller (MVC) rất bình thường trong tăng trưởng web hiện nay vì nó giúp giữ cho mã của bạn có tổ chức và được thiết kế để hạn chế việc bảo trì.
  • Gần giống, mẫu Thực thể-Thành phần-Hệ thống (ECS) rất bình thường trong tăng trưởng trò chơi vì nó khiến cho mô-đun dữ liệu trò chơi dễ bảo trì hơn.

Nắm vững các sắc thái biệt lập của tiếng nói được sử dụng

Nắm vững các sắc thái riêng biệt của ngôn ngữ được sử dụng

1 trong những gieo neo trong việc thuần thục 1 tiếng nói lập trình mới là học các sắc thái tách biệt nó với tất cả các tiếng nói khác. Những sắc thái này có thể là sự dị biệt giữa mã bẩn, phức tạp và mã sạch, dễ bảo trì.

Hãy phê chuẩn Python, Java và JavaScript, 3 tiếng nói này có sự dị biệt rất rõ ràng. Trong lúc Python nổi trội với các dòng mã ngắn và dễ dàng, thì Java rõ ràng theo 1 cách khá dông dài. Vì thế mỗi tiếng nói lập trình đều có những sắc thái riêng, trước lúc muốn code sạch thì bạn phải học và hiểu chúng!

Học mã sạch từ các bậc thầy trong ngành

Học mã sạch từ các bậc thầy trong ngành

Nếu bạn muốn viết mã sạch, cách tốt nhất là “quan sát” mã sạch trông như thế nào và nỗ lực hiểu vì sao mã sạch là như thế nào. Không có cách nào tốt hơn để làm điều này bằng cách nghiên cứu các tệp mã nguồn của những người đi trước, đặc trưng là của các nhân vật được coi là Thạc sĩ trong ngành.

Dĩ nhiên bạn chẳng thể vào hội sở của Microsoft và xem qua các dự án của họ, nhưng mà bạn luôn có thể tham khảo các dự án mã nguồn mở nổi danh. Hãy thử 1 số dự án xuất sắc trên Github!

1 trong những lý do khiến các dự án mã nguồn mở được hoan nghênh là giúp người khác học được nhiều điều từ mã của họ.

Viết 1 bình luận cân đối

Viết nhận xét cân đối, thích hợp là lời khuyên lâu đời nhất trong toàn cầu lập trình. Trên thực tiễn, ngay tính từ lúc được giới thiệu bình luận, “lính mới” thường có xu thế lạm dụng bình luận 1 cách thái quá – mô tả những điều ko thiết yếu, thiếu góc nhìn về 1 “bình luận cân đối” tức là gì.

Đây là 1 luật lệ chung: nhận xét còn đó để giảng giải lý do vì sao 1 đoạn mã còn đó, chứ không hề những gì mã thực thụ làm. Nếu mã được viết đủ rõ ràng, nó có thể tự giảng giải về những gì nó làm – các nhận xét chỉ nên làm minh bạch ý định đằng sau lý do vì sao nó được viết.

Refactor, Refactor, Refactor

Lập trình lại 1 hoạt động biên tập giúp mã nguồn dễ đọc hơn, có tổ chức hơn và có thể là kiến ​​trúc / cấu trúc tốt hơn, nhưng mà ko chỉnh sửa tính năng hoạt động của hệ thống.

Nói 1 cách dễ dàng, tái cấu trúc (tái cấu trúc, cải thiện mã) là 1 cách kỳ diệu để làm sạch mã. Đây có thể được coi là mẹo quan trọng nhất nếu bạn muốn mã của mình “sạch”.

Vậy là xong, nếu bạn đang mày mò và muốn viết code sạch thì có thể dùng thử. Nếu có thủ thuật hay, rất mong các bạn san sớt thêm với Phần Mềm Portable VN.


 

Thông tin thêm

9 tip giúp bạn viết code “ngon nghẻ” hơn

[rule_3_plain]

Viết code hiển nhiên là nhiệm vụ bậc nhất nếu bạn là 1 nhà tăng trưởng ứng dụng. Tuy nhiên, có bao giờ bạn nghĩ code của mình đã thực thụ tốt chưa?
Giữ cho code “sạch đẹp”, rõ ràng và dễ đọc là 1 lề thói tốt nhưng mà không hề developer nào cũng ân cần đến. Thật đáng tiếc, bởi việc code sạch thật sự sẽ chỉnh sửa và tác động đến nhiều thứ trong project của bạn.
Vậy Code sạch – Clean Code là gì?

Clean Code hiểu tường minh tức là code sạch, code rõ ràng, dễ đọc.
Về vẻ ngoài, Clean Code trình bày như sau:

Cách thể hiện code: cách căn lề, thụt lề sử dụng tab, space… sao cho dễ đọc, đã mắt.
Cách đặt tên biến, hàm, class có theo những nguyên lý chung lúc lập trình ko?
Cách cung ứng lượng code (số dòng code trong file, số dòng code trong 1 method…)

Về nội dung cần phê chuẩn:

Cách đặt tên hàm, tên biến phải dễ đọc, dễ hiểu.
Xác định lúc nào nên viết comment cho code, lúc nào ko.
Thiết kế xây dựng cấu trúc của nhân vật (Object) dữ liệu dễ sử dụng và dễ mở mang.
Thiết kế cách xử lý ngoại lệ (Exception) cân đối.
Khả năng maintain, mở mang của code đã tốt chưa?

Nghe thì dễ dàng vậy thôi nhưng mà không phải dễ dãi đâu nhé.
Vì thế với bài viết này, Phần Mềm Portable VN sẽ liệt kê ra 9 tip tạo điều kiện cho bạn viết code “clean and better”. Mời độc giả theo dõi!
Đặt tên có ý nghĩa

Xin hỏi rằng: các nhân vật, các biến, các lớp, các hàm có tức là gì? Có rất nhiều khái niệm học thuật về các định nghĩa này, nhưng mà lúc nghĩ suy 1 cách toàn cục, có thể khẳng định đây chính là mối kết hợp giữa các lập trình viên và sự logic căn bản của phần mềm mình đang viết.
Nếu bạn sử dụng các loại tên mập mờ, ko miêu tả căn bản về các biến, lớp, hàm thì bạn đang tự tay “che đậy” các logic phần mềm và gây gieo neo cho mình nếu 1 thời kì sau cần update và biên tập phần mềm. Điều này cũng dẫn những người đồng nghiệp sẽ đọc code của bạn sau này vào 1 mê cung ko thấy đường đi lối lại.

“Tôi không hề là 1 lập trình viên xuất sắc; tôi chỉ là 1 lập trình viên giỏi với những lề thói xuất sắc.” – Kent Beck

1 biến có tên là abc có tức là gì? Chịu luôn! Bạn có thể sẽ cần phải đọc lại toàn thể code để hiểu abc tức là gì!? Tựu chung vấn đề, đọc code kiểu này sẽ vô cùng khó nhọc. Thay vì muốn bộc lộ danh sách người mua bằng biến list1, hãy dùng listCustomer. Bởi vì list1 là 1 tên bất nghĩa, dễ gây lầm lẫn và bừa bãi lúc đọc. Điều này cũng đúng với việc đặt tên cho class hay function.
Vậy tóm lại tên biến đạt đề xuất phải giải đáp được 3 câu hỏi phệ:

WHAT: Nó là cái gì?
WHY: Nó dùng để làm gì ?
HOW: Làm sao sử dụng nó ?

Bỏ thêm vài giây để nghĩ suy 1 cái tên chuẩn, tiết kiệm được hàng giờ đồng hồ sau này.
Các hàm, các lớp nên viết ngắn gọn và làm 1 việc độc nhất
Bạn đã bao giờ gặp phải 1 hàm dài hàng trăm, thậm chí hàng nghìn dòng chưa? Nếu rồi, bạn hẳn phải hình dung ra sẽ âu sầu như nào nếu ta phải duyệt, đọc, hay biên tập các hàm tương tự. Các comment có nhẽ sẽ giúp ích 1 chút, không những thế chỉ ở chừng độ rất giảm thiểu.
Vậy nên, hàm phải ngắn hết mức có thể. 1 hàm lý tưởng ko nên viết quá 20 dòng. Về nguyên lý, nếu hàm quá dài hãy chia bé thành các hàm con, mỗi hàm con tiến hành 1 việc độc nhất. Tên của hàm phải trình bày rõ công dụng độc nhất của nó.
Thí dụ 1 hàm phức tạp như GetCreditScore() có thể được phân thành nhiều hàm viện trợ bé hơn kiểu dạng GetCreditReports(), ApplyCreditHistoryAge() và FilterOutstandingMarks()…
Xóa bỏ các đoạn code ko thiết yếu

Thói quen xấu giữ lại 1 số đoạn code dôi thừa là 1 trong những điều nhưng lập trình viên nào cũng trải đời qua. Chắc chắn bạn sẽ không xa lạ với kịch bản thế này: bạn muốn tu sửa hoặc tối ưu hóa 1 đoạn code, nhưng mà sau lúc comment và viết 1 đoạn code mới – và dù rằng nó đã hoạt động thì bạn vẫn giữ lại đoạn code cũ ở đấy.
Theo thời kì những comment ấy ko thiết yếu nữa và sẽ làm cho file nguồn của bạn bị bừa bãi. Do đấy, lúc có 1 đoạn code thừa, có cũng như ko thì chúng ta cần loại trừ khỏi source code luôn để phần mềm của bạn sạch hơn nhé.
Tránh rút gọn code quá mức
Có rất nhiều lập trình viên muốn liên kết clean code – code sạch với clever code – code sáng dạ, như kiểu dồn 10 dòng thành 1 bằng cách nào đấy thì nhìn nó sẽ clean hơn. Điều này vững chắc sẽ giúp đoạn code tốn ít ko gian trên màn hình, không những thế liệu nó thực thụ dễ hiểu?
Câu giải đáp là đôi lúc có thể, nhưng mà phần phệ khẳng định là nó ko dễ hiểu chút nào cả!
Thông thường, việc viết code “sáng dạ” thường là để trình bày cái tôi tư nhân, hay ngầm trình bày rằng “à đầu óc mình sáng dạ nên mới nghĩ ra được tương tự”. Cũng có trường hợp người viết ham thích với thách thức tạo ra sự dị biệt, nhưng mà vô tình lại làm khó người đọc hiểu code về sau.
Vì thế, để viết code sạch, bạn hãy đặt cái tôi của mình ra sau, hãy tối ưu code để cả người tiếp theo làm việc với phần mềm cũng có thể hiểu được. Thậm chí 1 thời kì sau, người sử dụng code này vẫn là bạn, và bạn lại ko nhớ những lối tắt sử dụng trong đoạn code ngắn gọn này của mình tức là gì, cũng có thể lắm chứ! Thật kỳ cục nếu bạn nói rằng chẳng thể hiểu được mình đã từng làm gì phải ko?
Chọn lọc kiến trúc thích hợp với project

Có rất nhiều mẫu hình và kiến trúc không giống nhau nhưng bạn có thể sử dụng để tạo dự án của mình. Nhưng hãy luôn xem xét rằng, cần chọn đúng kiến trúc cho nhu cầu của bạn, chứ không hề chọn 1 trong những cái tốt nhất.
Thí dụ:

Mẫu hình Model-View-Controller (MVC) rất bình thường trong tăng trưởng web hiện tại vì nó giúp giữ code của bạn được diễn ra và thiết kế sao cho hạn chế tối đa việc bảo trì.
Gần giống, mẫu hình Entity-Component-System (ECS) rất bình thường trong tăng trưởng trò chơi bởi vì nó giúp module dữ liệu trò chơi có thể bảo trì dễ dãi hơn.

Nắm vững sắc thái biệt lập của tiếng nói sử dụng

1 trong những gieo neo trong việc thạo 1 tiếng nói lập trình mới là học các sắc thái tách nó ra khỏi tất cả các tiếng nói khác. Những sắc thái này có thể là sự dị biệt giữa 1 dirty code, phức tạp và clean code, dễ bảo trì.
Hãy phê chuẩn Python, Java và JavaScript, 3 tiếng nói này có sự dị biệt rất rõ ràng. Trong lúc Python nổi trội với các dòng code ngắn gọn và dễ dàng thì Java lại tường minh theo cách khá dông dài. Vì thế mỗi tiếng nói lập trình đều có các sắc thái riêng, trước lúc bạn muốn code sạch thì phải học nhưng thông suốt chúng đã nhé!
Học code sạch từ các Master trong ngành

Nếu bạn muốn viết code sạch, tốt nhất bạn nên “mục sở thị” xem code sạch bóng trông như thế nào và nỗ lực hiểu vì sao clean code lại là tương tự. Không có cách nào để làm điều này tốt hơn việc nghiên cứu các file mã nguồn của những người đi trước, đặc trưng là những dự án của các nhân vật được coi là Master trong ngành.
Dĩ nhiên là bạn chẳng thể vào hội sở chính của Microsoft và xem lén các dự án của họ, nhưng mà bạn luôn có thể tham khảo các dự án mã nguồn mở nổi danh. Hãy thử với các dự án xuất sắc trên Github xem nào!
1 trong những lý do các dự án mã nguồn mở rất được hoan nghênh đấy là giúp người khác có thể học hỏi nhiều điều từ code của mình.
Viết comment cân đối
Viết bình luận cân đối, phù hợp là lời khuyên lâu đời nhất trong toàn cầu lập trình. Thực tế, ngay tính từ lúc được giới thiệu về comment, những “newbie” thường có xu thế lạm dụng bình luận quá mức – miêu tả những điều ko cần phải miêu tả, thiếu ý kiến về 1 “comment cân đối” có tức là gì.
Đây là 1 nguyên lý bé: comment còn đó để giảng giải vì sao 1 đoạn code còn đó chứ không hề những gì nhưng đoạn code đấy thực thụ làm. Nếu code được viết đủ sạch, nó tự giảng giải như những gì nó làm – comment chỉ nên làm minh bạch về ý định đằng sau lý do vì sao nó được viết.
Refactor, Refactor, Refactor
Code refactoring là hoạt động biên tập khiến source code dễ đọc hơn, được diễn ra khoa học hơn, và có thể có kiến trúc/cấu trúc tốt hơn nhưng mà ko làm chỉnh sửa hành vi của hệ thống về mặt tính năng.
Hiểu dễ dàng, refactor (tái cấu trúc, cải tiến mã nguồn) là 1 cách kỳ diệu để làm sạch mã. Có thể xem đây là mẹo quan trọng nhất nếu bạn muốn code của mình được “clean”.
Hết rồi ấy, nếu bạn đang mày mò và muốn viết code sạch thì có thể vận dụng thử xem nhé. Nếu có mẹo nào hay ho, rất hoan nghênh bạn san sớt thêm với Phần Mềm Portable VN.

[rule_2_plain]

#tip #giúp #bạn #viết #code #ngon #nghẻ #hơn


  • Tổng hợp: Phần Mềm Portable
  • Nguồn: https://bigdata-vn.com/9-tip-giup-ban-viet-code-ngon-nghe-hon/
Back to top button