Ruby coding convention

      No Comments on Ruby coding convention

Ruby coding conventions

Coding convention

Coding conventions là tập hợp những nguyên tắc chung khi lập trình nhằm làm cho code dễ đọc, dễ hiểu, do đó dễ quản lý, bảo trì hơn.

Coding conventions có những cái chung và cái riêng tuỳ ngôn ngữ, tuỳ cộng đồng, nhưng hầu hết được công nhận và áp dụng bởi đa số các lập trình viên trên thế giới.

Coding convention trong ruby

Quy tắc đặt tên (naming convention)

Cú pháp lạc đà (camelCase)

Ký tự đầu tiên của từ đầu tiên viết thường những ký tự đầu tiên của những từ tiếp theo được viết hoa.
Ví dụ: productPrice, camelCasing, thisIsTheNameThatFollowTheCamelCase

Cú pháp Pascal (PascalCase)

Cú pháp Pascal viết hoa chữ cái đầu tiên của mỗi từ.
Ví dụ: ProductName, PascalCasing, ThisIsTheNameThatFollowThePascalCase

Cú pháp con rắn (snake_case)

Với pháp con rắn, tất cả các chữ cái đều viết thường, và các từ cách nhau bởi dấu gạch dưới.
Ví dụ: user_name, this_is_the_name_that_follow_the_snake_case
Ruby sử dụng snake_case trong hầu hết các trường hợp, tuy nhiên vẫn có 1 vài trường hợp ngoại lệ:
– Tên lớp thì đặt theo PascalCase
– Hằng số đặt theo UPPER_CASE, vd: CLICK_COUNTER

Một vài lưu ý khác:
– Tên biến, tên lớp thường là danh từ, cụm danh từ hoặc tính từ: UserModel, user_name, download_counter, downloaded?
– Tên hàm thường bắt đầu bằng động từ: push_to_user, increase_download_counter
– Tên thì phải có nghĩa, KHÔNG ĐƯỢC đặt tên kiểu viết tắt (dlCounter, uName, idl, a, a1, doFA)
– Tránh đặt những tên quá chung chung, tối nghĩa: top, best, doIncrease, getAll

Quy tắc về số lượng

Bob Martin phát biểu trong cuốn Clean Code: “if small is good, then smaller must be better”.

Số lượng dòng code trong hàm/lớp, số lượng hàm trong lớp, số lượng lớp trong gói phải giữ ở một giới hạn nhất định nào đó, và nên giữ càng ít càng tốt, ví dụ:
– Hàm không nên quá 30 dòng (Martin Lippert-rule 30)
– Lớp không nên vượt quá 500 dòng (Clean Code)
– Một hàm không được vượt quá 5 tham số, (nên giữ <=3)(Clean Code)
– Một hàm chỉ làm duy nhất 1 việc, trong trường hợp chính đáng, làm 2 việc cũng được phép, tuy nhiên tên hàm phải nói rõ điều này, vd: increase_download_counter_and_update_to_database
– Khi khai báo biến, một dòng chỉ chứa một biến
– Một dòng không nên dài quá 80 hoặc 120 (prefered) ký tự (Oracle)
– Các câu lệnh lồng nhau tối đa 4 cấp

Quy tắc xuống hàng

Theo Oracle
– Nếu có dấu phẩy thì xuống hàng sau dấu phẩy ,
– Xuống hàng trước toán tử + -
– Nếu có nhiều cấp lồng nhau, thì xuống hàng theo từng cấp
– Dòng xuống hàng mới thì nên bắt đầu ở cùng cột với đoạn lệnh cùng cấp ở trên.

Comment

  • Hạn chế dùng comment để giải thích code, thay vào đó hãy cải thiện đoạn code.
  • Chỉ nên dùng comment trong trường hợp viết documentation cho thư viện, thông tin đính kèm cho class

Để áp dụng các convention này, các editor có các plugin giúp mình kiểm tra và sửa lỗi, mời bạn đọc bài viết về Ruby linter và các linter plugin cho atom và sublimetext để hiểu thêm 🙂

Lập trình và hơn thế nữa

Spread the love
  •  
  •  
  •  
  •  
  •  

Leave a Reply

Be the First to Comment!

avatar
  Subscribe  
Notify of