Theo bạn, &ldquo;code sạch&rdquo; l&agrave; g&igrave;? C&oacute; rất nhiều c&aacute;ch định nghĩa code sạch nhưng định nghĩa phổ biến nhất như sau: 
&ldquo;Code sạch l&agrave; code dễ đọc hiểu v&agrave; dễ thay đổi hay bảo tr&igrave;.&rdquo;
Do mọi người ng&agrave;y c&agrave;ng c&oacute; xu hướng đọc code mẫu hơn l&agrave; viết, việc luyện viết code sạch l&agrave; v&ocirc; c&ugrave;ng quan trọng đối với sự nghiệp lập tr&igrave;nh.
Trong b&agrave;i viết n&agrave;y, Tek4vn sẽ chia sẻ c&aacute;c kiến thức li&ecirc;n quan được t&iacute;ch lũy qua nhiều năm v&agrave; đưa ra v&iacute; dụ minh họa trong Python. Những nguy&ecirc;n tắc n&agrave;y n&ecirc;n được &aacute;p dụng chung trong hầu hết ng&ocirc;n ngữ lập tr&igrave;nh.
TL;DR
<ul style="text-align: justify;">
<li style="font-weight: 400;" aria-level="1">T&ecirc;n c&aacute;c đối tượng phải đồng nhất với nhau</li>
<li style="font-weight: 400;" aria-level="1">Tr&aacute;nh g&acirc;y nhầm lẫn cho t&ecirc;n đối tượng</li>
<li style="font-weight: 400;" aria-level="1">Tr&aacute;nh d&ugrave;ng hai lần phủ định</li>
<li style="font-weight: 400;" aria-level="1">Viết code tự giải th&iacute;ch</li>
<li style="font-weight: 400;" aria-level="1">Kh&ocirc;ng lạm dụng phần nhận x&eacute;t</li>
</ul>
<h2 style="text-align: justify;">1. Đặt t&ecirc;n ph&ugrave; hợp</h2>
<h3 style="text-align: justify;">Tr&aacute;nh g&acirc;y nhầm lẫn cho t&ecirc;n đối tượng</h3>
Mặc d&ugrave; đ&acirc;y l&agrave; nguy&ecirc;n tắc xưa như tr&aacute;i đất, nhưng người ta vẫn thường bỏ qua quy tắc cơ bản n&agrave;y. Lu&ocirc;n lu&ocirc;n hỏi bản th&acirc;n c&acirc;u hỏi sau trước khi đặt t&ecirc;n thư mục, h&agrave;m hoặc biến: &ldquo;Nếu t&ocirc;i đặt t&ecirc;n n&agrave;y, n&oacute; c&oacute; bị lẫn lộn với đối tượng kh&aacute;c hay g&acirc;y nhầm lẫn cho người đọc kh&ocirc;ng?
Nguy&ecirc;n tắc l&agrave; lu&ocirc;n tr&aacute;nh mọi sự nhầm lẫn c&oacute; thể khi đặt t&ecirc;n cho đối tượng.
<pre class="language-python"><code># For example, you're naming a variable that represents the user&rsquo;s membership expiration:
# Example 1
# ^^^^^^^^^
# Don't
expired = True
# Do
is_expired = True
# Example 2
# ^^^^^^^^^
# Don't
expire = '2021-04-17 03:25:37.403283'
# Do
expiration_date = '2021-04-17 03:25:37.403283' # OR
expiration_date_string = '2021-04-17 03:25:37.403283'</code></pre>
Ta kh&ocirc;ng n&ecirc;n sử dụng t&ecirc;n <code>expired</code> v&igrave; bản th&acirc;n từ n&agrave;y mang nhiều nghĩa. Một lập tr&igrave;nh vi&ecirc;n mới tham gia dự &aacute;n sẽ kh&ocirc;ng biết <code>expired</code> chỉ ng&agrave;y th&aacute;ng hay gi&aacute; trị boolean.
<h3 style="text-align: justify;">Đặt t&ecirc;n đồng nhất với nhau</h3>
Khi l&agrave;m việc theo nh&oacute;m, bạn n&ecirc;n duy tr&igrave; sự nhất qu&aacute;n trong t&ecirc;n biến, tệp, h&agrave;m v&agrave; thậm ch&iacute; l&agrave; cấu tr&uacute;c thư mục xuy&ecirc;n suốt dự &aacute;n để tr&aacute;nh g&acirc;y nhầm lẫn v&agrave; hiểu lầm kh&ocirc;ng đ&aacute;ng c&oacute;.&nbsp;
Kh&ocirc;ng n&ecirc;n đặt t&ecirc;n dựa tr&ecirc;n sở th&iacute;ch c&aacute; nh&acirc;n. Nhớ kiểm tra code của của những đồng đội kh&aacute;c v&agrave; b&agrave;n luận thống nhất trước khi thay đổi bất kỳ t&ecirc;n n&agrave;o.
<pre class="language-python"><code># For example if the existing project names a Response object as "res" already:

# Existing functions
# ^^^^^^^^^^^^^^^^^^
def existing_function(res, var): 
 # Do something...
 pass 

def another_existing_function(res, var): 
 # Do something...
 pass 

# Example 1
# ^^^^^^^^^
# Don't
def your_new_function(response, var): 
 # Do something...
 pass 

# Do
def your_new_function(res, var): 
 # Do something...
 pass </code></pre>
<h3 style="text-align: justify;">Mẹo đặt t&ecirc;n</h3>
<ol style="text-align: justify;">
<li style="font-weight: 400;" aria-level="1">Đặt t&ecirc;n biến l&agrave; danh từ (v&iacute; dụ: <code>product_name</code>).</li>
<li style="font-weight: 400;" aria-level="1">H&agrave;m thực hiện thao t&aacute;c th&igrave; n&ecirc;n đặt t&ecirc;n l&agrave; cụm động từ (v&iacute; dụ: <code>def compute_user_score()</code>).</li>
<li style="font-weight: 400;" aria-level="1">Đặt t&ecirc;n cho biến boolean hoặc h&agrave;m trả về boolean l&agrave; c&acirc;u hỏi (v&iacute; dụ: <code>def is_valid()</code>).</li>
<li style="font-weight: 400;" aria-level="1">Đặt t&ecirc;n tương ứng với chức năng nhưng kh&ocirc;ng n&ecirc;n qu&aacute; chi tiết (v&iacute; dụ: n&ecirc;n đặt <code>def compute_fibonacci()</code> l&agrave; thay v&igrave; <code>def compute_fibonacci_with_dynamic_programming()</code>).</li>
</ol>
<h2 style="text-align: justify;">2. Tr&aacute;nh phủ định hai lần</h2>
&ldquo;Bạn c&oacute; thể đảm bảo sẽ kh&ocirc;ng qu&ecirc;n kh&ocirc;ng tắt điện chứ?&rdquo;
- Hừm, vậy t&ocirc;i c&oacute; n&ecirc;n tắt điện hay kh&ocirc;ng? Phải đọc lại c&acirc;u hỏi mới được.
Bạn cũng thấy đấy, hai lần phủ định khiến cho &yacute; nghĩa của c&acirc;u n&oacute;i trở n&ecirc;n mơ hồ v&agrave; kh&oacute; x&aacute;c định.
<pre class="language-python"><code># Example to check if a user's membership is valid or not:

# Don't
is_invalid = False
if not is_invalid:
 print("User's membership is valid!")

# Do
is_valid = True
if not is_valid:
 print("User's membership is invalid!")</code></pre>
Chắc hẳn sẽ kh&ocirc;ng dễ chịu g&igrave; khi phải đọc lại code lần nữa để hiểu &yacute; nghĩa.
<h2 style="text-align: justify;">3. Viết code tự giải th&iacute;ch</h2>
C&oacute; ai đ&oacute; đ&atilde; từng n&oacute;i tho&aacute;ng qua với t&ocirc;i rằng lập tr&igrave;nh vi&ecirc;n n&ecirc;n viết nhận x&eacute;t ở mọi chỗ để &ldquo;tăng chất lượng code&rdquo;.
Nhận định ấy thực ra đ&atilde; lỗi thời rồi. Xu thế hiện nay l&agrave; c&aacute;c lập tr&igrave;nh vi&ecirc;n n&ecirc;n viết code tự giải th&iacute;ch sao cho dễ hiểu đối với mọi người. V&iacute; dụ, ta n&ecirc;n biến một đoạn logic phức tạp th&agrave;nh một biến m&ocirc; tả tự giải th&iacute;ch.
<pre class="language-python"><code># Don't write long conditionals
if meeting and (current_time &gt; meeting.start_time) and (user.permission == 'admin' or user.permission == 'moderator') and (not meeting.is_cancelled):
 print('# Do something...')

# Do capture them in multiple variables that reads like English
is_meeting_scheduled = meeting and not meeting.is_cancelled
has_meeting_started = current_time &gt; meeting.start_time
has_user_permission = user.permission == 'admin' or user.permission == 'moderator'
if is_meeting_scheduled and has_meeting_started and has_user_permission:
 print('# Do something...')</code></pre>
<h3 style="text-align: justify;">Kh&ocirc;ng lạm dụng comment code</h3>
Cũng như code, nhận x&eacute;t c&oacute; thể trở n&ecirc;n lỗi thời v&agrave; kh&ocirc;ng c&ograve;n ph&ugrave; hợp v&agrave;o thời điểm n&agrave;o đ&oacute;.
Mọi người thường qu&ecirc;n cập nhật nhận x&eacute;t khi code được chỉnh sửa. Khi đ&oacute;, bản th&acirc;n phần nhận x&eacute;t sẽ gi&aacute;n tiếp g&acirc;y ra nhầm lẫn cho người đọc.
Bất cứ khi n&agrave;o cảm thấy cần thiết phải viết nhận x&eacute;t, h&atilde;y nhớ xem lại code vừa viết v&agrave; chỉnh sửa sao cho code dễ hiểu hơn.
<h3 style="text-align: justify;">V&iacute; dụ trường hợp cần viết comment code</h3>
Th&ocirc;ng thường ch&uacute;ng ta n&ecirc;n sử dụng nhận x&eacute;t khi cần cắt chuỗi. Để biết khi n&agrave;o cần viết nhận x&eacute;t, h&atilde;y đặt c&acirc;u hỏi: &ldquo;Tại sao phải d&ugrave;ng c&aacute;ch n&agrave;y? Tại sao kh&ocirc;ng d&ugrave;ng c&aacute;c chỉ mục kh&aacute;c?&rdquo; v&agrave; &aacute;p dụng tương tự.
<pre class="language-python"><code># Example of getting an email returned from a 3rd party API:

# Example 1
# ^^^^^^^^^
# Do
raw_string = get_user_info()
email = raw_string.split('|', maxsplit=2)[-1] # NOTE: raw_string e.g. "Magic Rock|jerry@example.com"
</code></pre>
V&iacute; dụ kh&aacute;c:
<pre class="language-python"><code># Example of a function calling a random time.sleep():

# Example 2
# ^^^^^^^^^
# Don't
def create_user(user_ids):
 for id in user_ids:
 make_xyz_api_request(id)
 time.sleep(2)</code></pre>
Giả sử bạn l&agrave; một lập tr&igrave;nh vi&ecirc;n mới v&agrave;o nghề v&agrave; mới quan s&aacute;t đoạn code tr&ecirc;n lần đầu. Bạn c&oacute; thể nghĩ rằng &ldquo;Tại sao ch&uacute;ng ta phải đợi ngẫu nhi&ecirc;n mỗi 2 gi&acirc;y để mỗi c&acirc;u lệnh tiếp theo được thực hiện?&rdquo;
Thực ra, mục đ&iacute;ch của người viết code l&agrave; giới hạn số c&acirc;u lệnh gửi tới API của b&ecirc;n thứ ba.
<pre class="language-python"><code># Do
def create_user(user_ids):
 for id in user_ids:
 make_xyz_api_request(id)
 time.sleep(2) # NOTE: service 'xyz' has a rate limit of 100 requests/min, so we should slow our requests down
</code></pre>
H&atilde;y lu&ocirc;n đặt bản th&acirc;n v&agrave;o suy nghĩ của người kh&aacute;c. (V&iacute; dụ: &ldquo;Người kh&aacute;c hiểu code của t&ocirc;i như thế n&agrave;o?&rdquo;. Nếu chia chuỗi hoặc sử dụng chỉ mục cụ thể từ danh s&aacute;ch (v&iacute; dụ: <code>array[3]</code>) th&igrave; kh&ocirc;ng ai c&oacute; thể hiểu mục đ&iacute;ch của bạn l&agrave; g&igrave;.
<h3 style="text-align: justify;">&Aacute;p dụng những kiến thức tr&ecirc;n như thế n&agrave;o?</h3>
Kh&ocirc;ng ai c&oacute; thể viết code sạch trong ng&agrave;y một ng&agrave;y hai được. Sự thật l&agrave;, khởi đầu của mọi người chỉ l&agrave; những đoạn code &ldquo;tệ&rdquo; hoặc &ldquo;xấu&rdquo;.
Trong cuộc sống cũng vậy, để giỏi thứ g&igrave; đ&oacute;, bạn cần thực h&agrave;nh v&agrave; thực h&agrave;nh nhiều hơn nữa, đồng nghĩa với đầu tư thời gian v&agrave; c&ocirc;ng sức.
B&ecirc;n cạnh việc thực h&agrave;nh, bạn cũng c&oacute; thể n&acirc;ng cấp bản th&acirc;n theo c&aacute;ch như t&ocirc;i đ&atilde; l&agrave;m:
<ul style="text-align: justify;">
<li style="font-weight: 400;" aria-level="1">Lu&ocirc;n đặt c&acirc;u hỏi &ldquo;C&oacute; c&aacute;ch n&agrave;o để cải thiện code kh&ocirc;ng? Người kh&aacute;c c&oacute; nhầm lẫn khi đọc code kh&ocirc;ng?&rdquo;</li>
<li style="font-weight: 400;" aria-level="1">Tham gia c&aacute;c phần review code.</li>
<li style="font-weight: 400;" aria-level="1">Tham khảo những nơi cung cấp code sạch. Nếu muốn tham khảo code sạch v&agrave; code Python, h&atilde;y xem thư viện Python <a href="https://github.com/psf/requests">requests</a>.</li>
<li style="font-weight: 400;" aria-level="1">Tr&ograve; chuyện, thảo luận v&agrave; trao đổi &yacute; kiến với mọi người. Bạn chắc chắn sẽ học hỏi nhanh hơn từ phương ph&aacute;p n&agrave;y.</li>
</ul>
<h2 style="text-align: justify;">Kết luận</h2>
Việc giải th&iacute;ch tầm quan trọng của code sạch đối với những người kh&ocirc;ng c&oacute; chuy&ecirc;n m&ocirc;n kỹ thuật thường kh&oacute; khăn bởi n&oacute; kh&ocirc;ng mang đến gi&aacute; trị lợi nhuận tức th&igrave; cho c&ocirc;ng ty. Để viết code sạch cũng tốn kh&aacute; nhiều thời gian v&agrave; sức lại v&agrave; l&agrave; nguy&ecirc;n nh&acirc;n gi&aacute;n tiếp g&acirc;y tốn k&eacute;m chi ph&iacute; cho doanh nghiệp.
Tuy nhi&ecirc;n, về l&acirc;u d&agrave;i, việc lưu trữ code sạch trong cơ sở code kh&aacute; quan trọng đối với lập tr&igrave;nh vi&ecirc;n. Với cơ sở dữ liệu code sạch, lập tr&igrave;nh vi&ecirc;n c&oacute; thể ph&acirc;n phối code v&agrave; triển khai sử dụng nhanh hơn nhằm đ&aacute;p ứng mục ti&ecirc;u của doanh nghiệp.
Hơn hết, code sạch l&agrave; nền tảng để những cộng t&aacute;c vi&ecirc;n hoặc người đ&oacute;ng g&oacute;p mới v&agrave;o dự &aacute;n c&oacute; thể hiểu nhanh ch&oacute;ng v&agrave; theo kịp tiến độ.

Admin

Cách viết code rõ dàng, dễ hiểu

Cùng tác giả

Admin

Có liên quan