<p><img style="width: 700px; display: block; margin-left: auto; margin-right: auto;" src="https://tek4.vn/public_files/cb8654bc-fff1-4d1a-9040-e513294050c9" alt="Comment" /></p>
<p style="text-align: justify;"><strong><em>&ldquo;Ưu ti&ecirc;n viết code đơn giản thay v&igrave; code phức tạp.&rdquo; </em></strong><span style="font-weight: 400;">Tốt hơn hết l&agrave; ta n&ecirc;n l&agrave;m theo c&aacute;c nguy&ecirc;n tắc căn bản thay v&igrave; c&aacute;c kỹ thuật cao si&ecirc;u. C&oacute; phải bạn đang nghĩ rằng c&aacute;c nh&acirc;n vi&ecirc;n Google thường viết code kh&aacute; phức tạp, kh&oacute; hiểu? Thực ra, điều ngược lại mới đ&uacute;ng, những lập tr&igrave;nh vi&ecirc;n kinh nghiệm thường viết code sao cho dễ hiểu nhất c&oacute; thể.</span></p>
<p style="text-align: justify;"><span style="font-weight: 400;">Bạn c&oacute; biết rằng comment cũng c&oacute; rất nhiều kiểu? Bạn đ&atilde; biết c&aacute;ch &aacute;p dụng comment đ&uacute;ng chưa? Nếu chưa biết c&aacute;ch sử dụng comment sao cho ph&ugrave; hợp, h&atilde;y c&ugrave;ng t&igrave;m hiểu qua b&agrave;i viết n&agrave;y nh&eacute;!</span></p>
<h2 style="text-align: justify;"><strong>Legal Comment</strong></h2>
<pre class="language-python"><code>//  SwiftyJSON.swift
//
//  Copyright (c) 2014 - 2017 Ruoyu Fu, Pinglin Tang
//
//  Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.</code></pre>
<p style="text-align: justify;"><span style="font-weight: 400;">Đ&acirc;y l&agrave; một kiểu comment kh&aacute; phổ biến. Nếu đang l&agrave;m việc cho một doanh nghiệp lớn về c&ocirc;ng nghệ, y tế hay kh&iacute; dầu, chắc chắn bạn sẽ biết về legal comment, một loại comment c&oacute; bản quyền. N&oacute; bao gồm c&aacute;ch sử dụng, thỏa thuận ph&aacute;p l&yacute; hoặc những thứ li&ecirc;n quan. Đ&acirc;y được gọi l&agrave; legal comment. Legal comment l&agrave; một kiểu comment tốt. Legal comment l&agrave; một kỹ năng bắt buộc đối với lập tr&igrave;nh vi&ecirc;n khi l&agrave;m việc cho c&aacute;c tổ chức lớn.</span></p>
<h2 style="text-align: justify;"><strong>Informative Comment</strong></h2>
<pre class="language-python"><code>// matches US social security number
let pattern = Pattern("^\\{3}-\\d{2}-\\d{4}$")</code></pre>
<p style="text-align: justify;"><span style="font-weight: 400;">Đ&acirc;y l&agrave; một biểu thức ch&iacute;nh quy. Phần comment đang n&oacute;i rằng code khớp với Số An sinh X&atilde; hội của Mỹ. Th&ocirc;ng tin n&agrave;y kh&aacute; hữu &iacute;ch đối với những người đang l&agrave;m trong dự &aacute;n nhưng kh&ocirc;ng biết g&igrave; về regex. Bạn vẫn c&oacute; thể đọc biểu thức m&agrave; kh&ocirc;ng cần thực sự hiểu n&oacute;.</span></p>
<h2 style="text-align: justify;"><strong>Explanation of Intent</strong></h2>
<pre class="language-python"><code>(defun swift-skip-type-name ()
    "Hop over any comments, whitespace, and the name of a type if
one is present, returning t if so and nil otherwise"
  (swift-skip-comments-and-space)
  (let ((found nil))
    ;; repeatedly
    (while
        (and
         ;; match a tuple or an identifier + optional generic param list
         (cond
          ((looking-at "[[(]")
           (forward-sexp)
           (setq found t))
          ((swift-skip-simple-type-name)
           (setq found t)))
          ;; followed by "-&gt;"
         (prog2 (swift-skip-re "\\\\?+")
             (swift-skip-re "throws\\\\|rethrows\\\\|-&gt;")
           (swift-skip-re "-&gt;") ;; accounts for the throws/rethrows cases on the previous line
           (swift-skip-comments-and-space))))
    found))</code></pre>
<p style="text-align: justify;"><span style="font-weight: 400;">Đ&acirc;y l&agrave; code elm. Bạn kh&ocirc;ng cần cố gắng diễn giải code. Kiểu comment n&agrave;y được d&ugrave;ng để giải th&iacute;ch mục đ&iacute;ch của code.</span></p>
<h2 style="text-align: justify;"><strong>Clarification</strong></h2>
<pre class="language-python"><code>assertTrue(a.compareTo(a) == 0) // a == a
assetrTrue(a.compareTo(b) != 0) // a != b
assertTrue(a.compareTo(b) != -1) // a &lt; b</code></pre>
<p style="text-align: justify;"><span style="font-weight: 400;">Kiểu comment n&agrave;y thường được d&ugrave;ng khi viết test code v&agrave; so s&aacute;nh c&aacute;c gi&aacute; trị. Comment sẽ l&agrave;m r&otilde; c&aacute;c th&ocirc;ng số của code.</span></p>
<h2 style="text-align: justify;"><strong>Warning of Consequences</strong></h2>
<pre class="language-python"><code>import UIKit
// This test is going to take a while to run
func test_sending_a_really_big_file() {
		loadFile(fileName: "bigfile.data")
}</code></pre>
<p style="text-align: justify;"><span style="font-weight: 400;">Kiểu comment n&agrave;y được gọi l&agrave; </span><code><span style="font-weight: 400;">Warning of Consequences</span></code><span style="font-weight: 400;">. Comment n&agrave;y kh&aacute; hữu &iacute;ch khi bạn l&agrave;m việc với người kh&aacute;c. Nếu kh&ocirc;ng c&oacute; comment cảnh b&aacute;o, cộng t&aacute;c vi&ecirc;n sẽ tốn th&ecirc;m thời gian t&igrave;m kiếm vấn đề khi chương tr&igrave;nh chạy chậm.</span></p>
<h2 style="text-align: justify;"><strong>TODO Comment</strong></h2>
<pre class="language-python"><code>// TODO-Paige
// We expect this to go away when we do the checkout model
private func makeVersion() {
}</code></pre>
<p style="text-align: justify;"><span style="font-weight: 400;">Một kiểu comment kh&aacute; phổ biến. N&oacute; phổ biến đến mức c&aacute;c tr&igrave;nh soạn thảo code như XCode, VSCode v&agrave; android studio đều nhấn mạnh kiểu todo comment n&agrave;y. Mục đ&iacute;ch của comment l&agrave; để th&ocirc;ng b&aacute;o rằng &ldquo;Chỗ n&agrave;y chưa xong. T&ocirc;i sẽ quay lại l&agrave;m tiếp sau.&rdquo;</span></p>
<p style="text-align: justify;"><span style="font-weight: 400;">H&atilde;y lu&ocirc;n đ&aacute;nh dấu phần code của bạn bằng </span><code><span style="font-weight: 400;">todo</span></code><span style="font-weight: 400;"> comment.</span></p>
<h1 style="text-align: justify;"><strong>Kết luận</strong></h1>
<p style="text-align: justify;"><span style="font-weight: 400;">Tr&ecirc;n đ&acirc;y l&agrave; một số loại comment th&ocirc;ng dụng nhất. Viết comment tốt l&agrave; một kỹ năng v&ocirc; c&ugrave;ng quan trọng đối với lập tr&igrave;nh vi&ecirc;n, v&igrave; thế nhớ viết comment cẩn thận để tr&aacute;nh g&acirc;y nhầm lẫn.</span></p>

Admin

Comments: Các lập trình viên Google viết comments như thế nào?

Cùng tác giả

Admin

Có liên quan