Hướng dẫn cách cải thiện chất lượng code
Cách c i thi n ch t l ng codeả ệ ấ ượ
Code ch t l ng là đi u mà ai cũng nh c đ n, nh ng ch a ch c đã th c ấ ượ ề ắ ế ư ư ắ ự
hi n.ệ
H u h t m i ng i đ u bi t th nào là t t, nh d đ c d hi u, không t nầ ế ọ ườ ề ế ế ố ư ễ ọ ễ ể ồ
t i l i nghiêm tr ng, cover đ y đ các tr ng h p, self-documenting code ạ ỗ ọ ầ ủ ườ ợ
v.vv.. th nh ng vi c vi t đ c l i khó h n nhi u. Li u ng i khác s ế ư ệ ế ượ ạ ơ ề ệ ườ ẽ
nghĩ sao v nh ng dòng code c a mình, s n m b t 1 cách đ n gi n hay ề ữ ủ ẽ ắ ắ ơ ả
coi nó nh ác m ng, th c s là th thách đ i v i m i l p trình viên. Khôngư ộ ự ự ử ố ớ ỗ ậ
ch th , khi d án c to d n lên, s có ngày chính b n không đ c n i ỉ ế ự ứ ầ ẽ ạ ọ ổ
nh ng gì b n thân đã vi t.ữ ả ế
Có th b n đã bi t: ể ạ ế
Đ không bao gi b qua ch t l ng code, c n ph i t o ra nh ng quy t c ể ờ ỏ ấ ượ ầ ả ạ ữ ắ
đ b n có th d a vào, đ luôn tham chi u đ n trong khi làm vi c.ể ạ ể ự ể ế ế ệ
D i đây là 5 quy t c mà tôi v n th c hi n m i khi code. Chúng giúp tôi ướ ắ ẫ ự ệ ỗ
đ t năng su t cao trong công vi c, giúp đ ng nghi p c a tôi có th d dàngạ ấ ệ ồ ệ ủ ể ễ
ti p c n và tri n khai các đo n code c a tôi. Tôi mong r ng chúng cũng có ế ậ ể ạ ủ ằ
th giúp b n code t t h n!ể ạ ố ơ
Test
Test là vi c mà ai cũng bi t là nên làm, nh ng đôi khi đ ng tr c áp l c ệ ế ư ứ ướ ự
th i gian, chúng ta hay l a ch n vi c đi t t. Th nh ng, dù ch là vài dòng ờ ự ọ ệ ắ ế ư ỉ
code đ n gi n cũng có th đ l i h u qu nghiêm tr ng n u chúng ta nghĩ ơ ả ể ể ạ ậ ả ọ ế
ch vi c gì ph i test.ả ệ ả
Đ 100% đ m b o code ch y t t, không có cách nào khác ngoài test.ể ả ả ạ ố
Hãy b t đ u v i unit test đ ki m tra xem t ng ph n nh có ho t đ ng ắ ầ ớ ể ể ừ ầ ỏ ạ ộ
đúng mong mu n hay ch a. Sau đó, d n d n test v i t ng subsystems, và ố ư ầ ầ ớ ừ
cu i cùng là test trên toàn b h th ng. Th c hi n hoàn ch nh theo trình t ố ộ ệ ố ự ệ ỉ ự
đó s giúp b n d dàng bi t đc n i v n đ có th phát sinh, xu t phát t ẽ ạ ễ ế ơ ấ ề ể ấ ừ
component đ n l hay subsystem nh nào.ơ ẻ ỏ
Đ t tên có ý nghĩaặ
Đây chính là self-documenting code. Khi b n đ c l i các đo n code cũ, b n ạ ọ ạ ạ ạ
không c n ph i xem k t ng comment hay ph i ch y th đ bi t ý nghĩa ầ ả ỹ ừ ả ạ ử ể ế
c a đo n code đó là gì.ủ ạ
Hãy đ code có th đ c đ c nh 1 đo n văn ti ng Anh đ n thu n. Đi u ể ể ọ ượ ư ạ ế ơ ầ ề
này áp d ng cho c tên bi n, class hay function. Chúng c n đ c đ t tên ụ ả ế ầ ượ ặ
sao cho không c n gi i thích v n hi u đ c. Thay vì l i bi ng đ là “x”, ầ ả ẫ ể ượ ườ ế ể
“y”, “z”, hãy l a ch n “width” hay “distance” – nh ng t ng đ i di n cho ự ọ ữ ừ ữ ạ ệ
th gi i th c.ế ớ ự
Class và function nên chia nh và tuân theo SRP (Single Responsibility ỏ
Principle)
Các class và function nh th c s có ích l i. Tr c h t, chúng cho phép ỏ ự ự ợ ướ ế
vi c unit test đ c di n ra đ c l p. N u đo n code b n đang ph i test nh ,ệ ượ ễ ộ ậ ế ạ ạ ả ỏ
vi c tìm ngu n và s a l i b t c v n đ nào xu t hi n trong khi test ho c ệ ồ ử ỗ ấ ứ ấ ề ấ ệ ặ
khi tri n khai tr nên d dàng h n.ể ở ễ ơ
Các class và function nh cũng giúp cho vi c đ c tr nên d dàng h n. ỏ ệ ọ ở ễ ơ
Thay vì có m t kh i code kh ng l v i nhi u vòng l p và vô s các bi n, ộ ố ổ ồ ớ ề ặ ố ế
b n có th gi m kh i code đó thành m t function có th ch y nhi u ạ ể ả ố ộ ể ạ ề
function khác nh h n. Sau đó b n có th đ t tên cho các function d a trên ỏ ơ ạ ể ặ ự
ch c năng c a chúng và đó, b n đã có m t đo n code mà con ng i có th ứ ủ ạ ộ ạ ườ ể
đ c hi u đ c !ọ ể ượ
SRP mang l i cho b n nh ng l i ích t ng t . Trách nhi m đ n có nghĩa làạ ạ ữ ợ ươ ự ệ ơ
b n ch c n test m t s ít các edge case và các tr ng h p đó t ng đ i dạ ỉ ầ ộ ố ườ ợ ươ ố ễ
dàng đ debug. Thêm vào đó, vi c đ t tên cho các function sao cho sát v i ể ệ ặ ớ
th c t cũng tr nên t ng đ i d dàng. Do m i function ch có m t m c ự ế ở ươ ố ễ ỗ ỉ ộ ụ
đích s d ng duy nh t nên các function này đ c đ t tên t ng ng v i ử ụ ấ ượ ặ ươ ứ ớ
m c đích c a nó, tránh đ c vi c ph i đ t tên cho m t function mà c n ụ ủ ượ ệ ả ặ ộ ầ
gi i quy t r t nhi u v n đ khác nhau.ả ế ấ ề ấ ề
B t và x lý các exceptions, ngay c khi b n nghĩ b n không c n ph i ắ ử ả ạ ạ ầ ả
làm đi u đóề
Các exceptions trong code th ng là các edge cases ho c các errors mà ườ ặ
chúng ta mong mu n đ c gi i quy t b ng cách th c riêng c a mình. Ví ố ượ ả ế ằ ứ ủ
d , thông th ng khi m t l i xu t hi n thì ch ng trình s ng ng ch y, ụ ườ ộ ỗ ấ ệ ươ ẽ ư ạ
đi u này ch c ch n chúng ta không mu n x y ra trên production – n i các ề ắ ắ ố ả ơ
end-users đang s d ng. Chúng ta c n xem xét l i đó riêng bi t, có khi ch ử ụ ầ ỗ ệ ỉ
th xem li u nó có th c s quan tr ng không, hay có th b qua nó.ử ệ ự ự ọ ể ỏ
B n nên th ng xuyên b t và x lý các exceptions m t cách c th ngay ạ ườ ắ ử ộ ụ ể
c khi b n nghĩ r ng mình không c n ph i làm th . Phòng còn h n ch a. ả ạ ằ ầ ả ế ơ ữ
Vi c gi i quy t các exceptions giúp cho b n n m b t đ c các th t và ệ ả ế ạ ắ ắ ượ ứ ự
ki m soát đo n code c a mình m t cách t t h n do b n hi u m t cách c ể ạ ủ ộ ố ơ ạ ể ộ ụ
th nh ng gì có th s x y ra n u nh nh ng exceptions xu t hi n hay ể ữ ể ẽ ả ế ư ữ ấ ệ
m t đo n code nh g p l i.ộ ạ ỏ ặ ỗ
Hi u bi t sâu h n v đo n code làm cho vi c debug tr nên d dàng và ể ế ơ ề ạ ệ ở ễ
giúp đo n code có kh năng kháng l i cao h n.ạ ả ỗ ơ
Logs, logs, logs
Hãy ghi l i log. Không bao gi logs tr nên th a thãi.ạ ờ ở ừ
Các log th c s là c u cánh hàng đ u cho vi c debug và theo dõi ng d ng ự ự ứ ầ ệ ứ ụ
đang ch y trên môi tr ng production. B n nên ghi l i log cho m i b c ạ ườ ạ ạ ỗ ướ
chính c a ch ng trình, b t c tính toán quan tr ng, errors, exceptions hay ủ ươ ấ ứ ọ
k t qu b t th ng nào. Vi c ghi l i log th i gian các s ki n đó di n ra ế ả ấ ườ ệ ạ ờ ự ệ ễ
cũng có th tr nên h u hi u cho vi c theo dõi. T t c nh ng thông tin này ể ở ữ ệ ệ ấ ả ữ
giúp cho vi c xác đ nh chính xác b c nào trong h th ng g p s c tr ệ ị ướ ệ ố ặ ự ố ở
nên đ n gi n h n.ơ ả ơ
Có r t nhi u ngôn ng l p trình ph bi n nh Python s d ng h th ng ấ ề ữ ậ ổ ế ư ử ụ ệ ố
ghi log riêng v i r t nhi u ch c năng h u ích mà b n có th tìm hi u. N u ớ ấ ề ứ ữ ạ ể ể ế
ph n m m c a b n ch y d i d ng ng d ng SaaS thì có th b n s ầ ề ủ ạ ạ ướ ạ ứ ụ ể ạ ẽ
mu n cân nh c vi c ghi log t p trung ngoài thi t b . B ng cách này khi m tố ắ ệ ậ ế ị ằ ộ
máy ch thu c h th ng g p s c thì b n cũng có th khôi ph c l i các ủ ộ ệ ố ặ ự ố ạ ể ụ ạ
logs m t cách d dàng!ộ ễ
có thể bạn quan tâm
Nghiên cứu ảnh hưởng của chất phụ gia lên chất lượng men sau khi sấy t...
112
865
310
Khoa học tự nhiên
112
(New)
Khảo sát ảnh hưởng của nhiệt độ và thời gian rửa cá trước khi cắt tiết...
96
734
283
Kỹ thuật
96
(New)
Khảo sát ảnh hưởng của tỷ lệ giống vi khuẩn sử dụng và nhiệt độ lên me...
70
722
302
Kinh tế quản lý
70
(New)
Khảo sát ảnh hưởng của các tỷ lệ pha loãng đến chất lượng sản phẩm sữa...
96
657
472
Kinh tế quản lý
96
(New)
3 ứng dụng giúp cải thiện chất lượng âm thanh trên macOS
5
979
261
Tài liệu CNTT khác
5
(New)
Tổng hợp 7 cách kết hợp SEO và Content Marketing để tạo ra traffic chấ...
6
716
246
Tài liệu CNTT khác
6
(New)
Chất lượng cho vay trung và dài hạn và một số giải pháp nâng cao chất...
69
672
305
Kinh tế - Thương mại
69
(New)
Tài liệu hướng dẫn ôn tập môn quản trị chất lượng
192
1.025
3.680
Tài liệu kinh tế khác
192
(New)
thông tin tài liệu
Dưới đây là 5 quy tắc mà bạn nên thực hiện mỗi khi code để giúp bạn đạt năng suất cao trong công việc, dễ dàng tiếp cận và triển khai các đoạn code.
Mở rộng để xem thêm
tài liệu mới trong mục này
tài liệu hot trong mục này
tài liệu giúp tôi
Nếu bạn không tìm thấy tài liệu mình cần có thể gửi yêu cầu ở đây để chúng tôi tìm giúp bạn!
×
