Code Convention là gì? Tổng hợp những quy tắc chung khi viết Code

Viết Code là một hoạt động không thể tránh khỏi khi bạn trở thành một lập trình viên. Tuy nhiên, để viết “Code sạch, Code đẹp” sao cho cả đội nhóm cùng hiểu là một vấn đề không thể thực hiện trong “một sớm một chiều”. Vì thế, Code Convention là một điều cần thiết để giúp Code của bạn tốt hơn. Vậy, Code Convention là gì? Những quy tắc chung khi viết Code ra sao?

Tìm hiểu về Code Convention

Code Convention là gì?

Code Convention được tạm dịch là quy ước viết Code. Có thể hiểu một cách đơn giản, Code Convention là một tập hợp các quy ước về cách để viết Code, đặt tên biến, class, hàm, file và rất nhiều quy tắc khác như thụt đầu dòng, comment, cách “.” cách “,”,… để cho các khối Code trở nên “clean” hơn.

Trong một dự án phần mềm lớn, khi toàn bộ lập trình viên của dự án đều tuân theo một quy tắc viết Code, giúp việc giao tiếp giữa các thành viên trở nên dễ dàng hơn. Dự án cũng sẽ có thể thêm các module chức năng nhanh chóng hơn, việc bảo trì và phát triển hệ thống sau này cũng sẽ dễ dàng hơn.

code-convention-la-gi

Tại sao nên sử dụng Code Convention?

Khi Code có Convention, hay Code theo quy tắc chung mà mọi người đều biết, điều này sẽ giúp cho hoạt động giải trí thao tác theo nhóm trở nên thuận tiện hơn. Trừ 1 số ít trường hợp đặc biệt quan trọng, thường thì, một dự án Bất Động Sản ứng dụng không hề được triển khai xong chỉ với một cá thể mà sẽ được triển khai theo nhóm. Nếu mỗi người viết một phong thái khác nhau, những người còn lại sẽ “ gai mắt ” hoặc không hiểu bạn đang viết gì .
Vì thế, việc Code theo một quy ước chung sẽ giúp cho cả nhóm thao tác trơn tru hơn, hiểu nhau hơn và giảm thiểu thực trạng những câu hỏi như : “ Bạn viết cái gì vậy ! ” “ Cái này là cái gì vậy bạn hiền ? ”, …
Vậy, khi Code Convention tất cả chúng ta sẽ có những quyền lợi như sau :

  • Giúp làm việc nhóm hiệu quả hơn
  • Thống nhất và tuân thủ theo một chuẩn dễ dàng làm việc hơn
  • Giúp người khác nắm bắt Code bạn viết nhanh hơn
  • Dễ dàng nâng cấp và cải tiến phần mềm
  • Có thể tái sử dụng trong nhiều phần mềm khác nhau
  • Thuận lợi trong việc phát triển và bảo trì hệ thống sau này

Tổng hợp những quy tắc chung khi viết Code

Naming Convention – quy tắc đặt tên

Một trong những việc khiến người khác có thể hiểu Code của bạn viết gì là thông qua: cách đặt tên các biến, hằng, class,… có thể gọi chung là định danh.

Khi triển khai một bài tập nhỏ lúc bạn học tin học cấp 3 hay những bài tập giải thuật đơn thuần, tất cả chúng ta được chỉ cách đặt tên biến là a, b, c, d. Tuy nhiên, điều này chỉ vận dụng cho những bài tập cấp thấp và không có quá nhiều công dụng .
Hãy tưởng tượng, một ứng dụng khổng lồ như Windows với cả ngàn tính năng, liệu việc đặt tên a-b-c-d sẽ hiệu suất cao trong việc tăng trưởng ? Không hề ! Nếu bạn đang học ĐH / cao đẳng / tầm trung và những thầy cô dạy vẫn chưa nói gì về đặt tên những hàm, những biến, sớm thôi họ cũng sẽ nhắc nhở bạn đấy !
Chúng ta sẽ có những cách đặt tên phổ cập như sau :

  • Cú pháp lạc đà – camelCase
  • Cú pháp Pascal – PascalCase
  • Cú pháp con rắn – snake_case

Tùy theo ngôn từ sẽ có một cách để sử dụng cú pháp riêng, nhưng bạn hoàn toàn có thể tìm hiểu thêm những ví dụ sẽ được nêu ngay sau đây nhé !
Trong hầu hết những công ty ứng dụng trong nước hay ngoài nước, quy tắc đặt định danh đều sẽ được mặc định là sử dụng tiếng Anh .
code-convention-la-gi

Cú pháp lạc đà – camelCase

Cú pháp lạc đà là cú pháp có cách viết từ tiên phong của cụm sẽ là viết thường và ký tự của những từ tiếp theo sẽ được viết hoa .ADVERTISEMENT

Thông thường, cú pháp này sẽ được dùng để viết các hàm, tên biến, phương thức.

Ví dụ về phương pháp, hàm : firstName, lastName, runLow ( ), getOnTop ( ), …
Ví dụ về biến : int i ; float spaceX, …

Cú pháp Pascal – PascalCase

Cú pháp Pascal là cú pháp sẽ được viết theo dạng viết hoa tổng thể những ký tự tiên phong trong từ của cụm .

Bạn có thể thấy việc này quá quen thuộc khi học Pascal lúc cấp 3, khi gõ lại bài tập từ một “thanh niên” nào đó “cứu” cả lớp đúng chứ? Thông thường, cú pháp này được sử dụng cho tên class, đôi khi là cả tên biến.

Ví dụ : class Mice, class MickeyMouse, …

Cú pháp con rắn – snake_case

Cú pháp con rắn sẽ có cách viết thông dụng là hàng loạt vần âm đều viết thường và tách nhau ra bằng dấu gạch dưới “ _ ”. Trong một vài trường hợp, một vài ngôn từ, tất cả chúng ta có biến thể là viết hàng loạt những vần âm đều in hoa .

Thông thường, chúng ta sẽ nhìn thấy cú pháp này trong việc đặt tên hằng và đôi khi là tên chương trình.

Ví dụ như: MAX_SLECT, final_final1_final2,…

code-convention-la-giNgoài ra, trong lúc đặt tên tất cả chúng ta còn cần phải quan tâm thêm :

  • Tên class, tên biến thường sử dụng danh từ
  • Tên hàm sẽ thường bắt đầu bằng động từ
  • Nên đặt tên theo kiểu gợi nhớ đến chức năng của chúng
  • Bạn không nên đặt tên theo kiểu viết tắt. Trong tương lai khi đọc lại Code bạn sẽ không hiểu hiện tại bạn đang viết gì
  • Tránh đặt tên theo kiểu chung chung không có ý nghĩa

Quy tắc số lượng

Một số quy tắc về số lượng trong cuốn sách Clean Code A Handbook of Agile Software Craftsmanship của Robert C. Martin, quyển Refactoring in Large Software Projects : Performing Complex Restructurings Successfully của Martin Lippert cũng như bộ quy tắc của Oracle có ghi như sau :

  • Một dòng Code không nên dài quá 80 ký tự
  • Một câu lệnh nên lồng tối đa 4 cấp
  • Một hàm không nên chứa quá 5 tham số
  • Một hàm không nên quá 30 dòng
  • Một class không nên vượt 500 dòng

Quy tắc comment – bình luận

  • Bạn nên tránh sử dụng comment để giải thích Code, việc hoàn thiện đoạn Code bằng như quy tắc đặt tên sẽ giúp Code của bạn dễ hiểu hơn.
  • Nếu bạn là người mới hoặc mau quên, việc sử dụng comment để giải thích việc mình làm với đoạn Code cũng là một ý hay đấy!

Quy tắc xuống hàng

Theo bộ quy tắc của Oracle, tất cả chúng ta có :

  • Nếu một hàm có nhiều cấp lồng nhau, mỗi cấp chúng ta nên xuống dòng.
  • Các đoạn Code bằng cấp nên ở cùng một cột với nhau, dòng xuống hàng nên bắt đầu cùng cấp với dòng phía trên.
  • Xuống hàng trước các toán tử ví dụ như: +, -, *, ?,…

Đến đây, Tino Group đã lý giải cho bạn về “ Code Convention là gì ” rồi đấy ! Bộ quy tắc viết Code sẽ nhờ vào vào từng ngôn từ, từng doanh nghiệp và nhiều lúc là từng dự án Bất Động Sản. Vì thế, bạn nên hỏi những người có tương quan trong dự án Bất Động Sản để nắm về quy tắc gõ để thao tác tốt hơn nhé ! Tino Group chúc bạn thành công xuất sắc !
Bài viết có tìm hiểu thêm từ nhiều nguồn : Viblo, TopDev, …

Những câu hỏi thường gặp về Code Convention

Viết Code không theo quy tắc được hay không?

Được. Nếu bạn viết Code đúng nhưng không theo một quy tắc thụt đầu dòng, đặt tên hay khoảng cách nào, chương trình vẫn hoàn toàn có thể chạy được. Tuy nhiên, chính bản thân bạn sẽ gặp rắc rối trong tương lai khi bạn không còn nhớ bạn đã viết gì đấy !

Tìm hiểu thêm về quy tắc viết Code ở đâu?

Nếu bạn muốn tìm hiểu thêm về các quy tắc viết Code, bạn có thể sử dụng từ khóa: Code Convention hoặc coding Convention để tìm kiếm trên Google hoặc Bing (sẽ cho ra nhiều kết quả tiếng Anh hơn hoặc bạn có thể sử dụng Google kết hợp với bộ lọc). Nếu muốn, bạn có thể tìm hiểu thêm tại bài viết của University Corporation for Atmospheric Research.

Tìm hiểu về quy tắc viết Code của JavaScript ở đâu?

Nếu bạn đang muốn khám phá thêm về quy tắc viết Code chung của JavaScript, bài viết và bài tập về JavaScript Coding Conventions của W3Schools sẽ là một trang rát tương thích để bạn hoàn toàn có thể học tập và nghiên cứu và điều tra đấy !

Tìm hiểu thêm về clean Code ở đâu?

Clean Code sẽ giúp cho bạn và đội nhóm khi thao tác trong một dự án Bất Động Sản ứng dụng được trơn tru hơn, bạn cũng hoàn toàn có thể tái sử dụng Code của mình cho nhiều dự án Bất Động Sản khác, cùng nhiều quyền lợi khác, Nếu bạn đang muốn khám phá thêm về clean Code, bài viết này của Tino Group sẽ tương hỗ bạn một phần đấy !

CÔNG TY CỔ PHẦN TẬP ĐOÀN TINO

  • Trụ sở chính: L17-11, Tầng 17, Tòa nhà Vincom Center, Số 72 Lê Thánh Tôn, Phường Bến Nghé, Quận 1, Thành phố Hồ Chí Minh
    Văn phòng đại diện: 42 Trần Phú, Phường 4, Quận 5, Thành phố Hồ Chí Minh
  • Điện thoại: 0364 333 333
    Tổng đài miễn phí: 1800 6734
  • Email: sales@tino.org
  • Website: www.tino.org

Source: https://wikifin.net
Category: Blog

Leave a Comment

Email của bạn sẽ không được hiển thị công khai. Các trường bắt buộc được đánh dấu *