Comment code là gì

Muốn làm phần mềm phải biết cách Comment code, tại sao như vậy ?

  1. Comment code là gì ?
  2. Cách thêm comment trong Google Apps Script
  3. Những lý do nên sử dụng comment trong mã nguồn
  4. Lưu ý khi sử dụng comment

1. Comment code là gì ?

Trong App Script (hoặc bất kỳ ngôn ngữ lập trình nào) "Comment code" là hành động thêm các chú thích (comment) vào mã nguồn của chương trình để giải thích hoặc ghi chú về những gì mã đó đang làm.

Cách comment code

Chú thích không làm thay đổi hoạt động của chương trình, mà chỉ giúp các lập trình viên khác (hoặc chính lập trình viên đó sau này) hiểu rõ hơn về mã nguồn.

2. Cách thêm comment trong Google Apps Script

Google Apps Script sử dụng ngôn ngữ JavaScript, vì vậy cách chú thích trong Apps Script cũng giống như trong JavaScript.

    Chú thích đơn (1) dòng

       Dùng dấu // để viết chú thích trên một dòng. Mọi thứ sau dấu // sẽ được coi là chú thích.
        Ví dụ:

    // Đây là một chú thích đơn dòng
    var x = 10;  // Chú thích ở cuối dòng mã

Chú thích đa dòng

    Dùng dấu /* để bắt đầu chú thích và dấu */ để kết thúc chú thích. Mọi thứ giữa hai dấu này sẽ là chú thích, bao gồm cả nhiều dòng.
    Ví dụ:

        /* Đây là một chú thích
           có thể bao gồm nhiều dòng
           trong mã của bạn. */
        var y = 20;

3. Những lý do nên sử dụng comment trong mã nguồn

    Giải thích logic của mã: Giúp người khác hoặc bạn sau này hiểu được mục đích và cách thức hoạt động của các phần trong mã.
    Tăng tính dễ đọc: Chú thích giúp mã dễ hiểu hơn, đặc biệt khi bạn làm việc nhóm hoặc quay lại làm việc sau một thời gian.
    Ghi chú tạm thời: Dùng chú thích để ghi chú các ý tưởng hoặc kế hoạch cho phần mã trong tương lai, hoặc để vô hiệu hóa một đoạn mã trong quá trình thử nghiệm.

4. Lưu ý khi sử dụng comment

    Không lạm dụng comment: Không nên viết quá nhiều chú thích, đặc biệt là những cái không cần thiết, vì nó có thể làm giảm tính sạch sẽ của mã nguồn.
    Cập nhật chú thích khi thay đổi mã: Nếu bạn thay đổi mã nguồn, hãy đảm bảo rằng các chú thích vẫn phản ánh chính xác những gì mà mã đang làm.

Tóm lại, comment code là một phần quan trọng trong lập trình giúp cho mã trở nên dễ hiểu và dễ duy trì hơn.

Tìm kiếm:

Bài viết liên quan:

Muốn làm phần mềm phải biết cách Comment code, tại sao như vậy ?