Home » None » Ruby Coding Convention (Phần 3)

Ruby Coding Convention (Phần 3)

ruby_convention
Ở phần hai, tôi đã giới thiệu về cú pháp trong Ruby, làm sao để các câu lệnh điều kiện, vòng lặp, block, methods … dễ hiểu, dễ đọc hơn, có qui tắc chung với cả team. Phần tiếp theo sẽ đề cập tới cách đặt tên và cách comment sao cho dể hiểu.

Naming

  • Tất cả các cách đặt tên biến, tên hàm cần được viết bằng tiếng Anh, và chỉ sử dụng các kí tự ascii
  • Đặt tên biến, tên hàm bằng chữ viết thường, cách nhau bởi dấu _

  • Đặt tên Class bằng cách viết hoa các chữ cái đầu tiên ClassName
  • Đặt tên hằng số bằng các chữ viết hoa toàn bộ, cách nhau bởi dấu _

  • Nhưng hàm trả về giá trị boolean cần được kết thúc bởi dấu ?. Ví dụ Array#empty?
  • Đối với những hàm có thể gây ra hậu quả gì đó (ví dụ như thay đổi đối tượng self) nên được kết thúc với dấu !

  • Sử dụng flat_map thay cho map ... .flatten

  • Sử dụng reverse_each(Không tạo ra array mới) thay cho reverse.each

Comments

  • Mỗi comment nên cách dấu # một dấu cách
  • Tránh những comment không cần thiết

  • Comment cũng cần được update. Những comment không được update nguy hiểm hơn cả không comment
  • Tránh comment cho những đoạn code chưa được refactor, rườm rà. Hãy refactor trước để code có thể dễ hiểu.
  • Đối với những comment dài, nên xuống dòng, và dòng dưới nên thụt vào 2 dấu cách
  • Thêm TODO đối với những chức năng cần được bổ sung về sau
  • Thêm FIXME đối với những chức năng cần được thay đổi, sửa
  • Thêm OPTIMIZE đối với những đoạn code chưa tối ưu làm ảnh hưởng tới performance
  • Thêm HACK đối với những đoạn code vi phạm practices và cần được refactor loại bỏ
  • Thêm REVIEW đối với những chức năng cần được xác nhận lại