Table of Content
Coding conventions
Coding conventions là tập hợp các 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ó các 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à đi theo bởi đa số các lập trình viên trên thế giới.
Các cú pháp thông dụng
Bạn đang đọc: Coding conventions trong lập trìnhCú pháp lạc đà (camelCase)
Ký tự đầu tiên của từ đầu tiên viết thường các ký tự đầu tiên của các từ tiếp theo được viết hoa. Thí 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ừ. Thí dụ: ProductName, PascalCasing, ThisIsTheNameThatFollowThePascalCase
Bạn đang đọc: Coding conventions trong lập trình
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ừ phương pháp nhau bởi dấu gạch dưới. Thí dụ: user_name, this_is_the_name_that_follow_the_snake_case Việc dùng cú pháp nào là tuỳ vào mỗi ngôn ngữ, mỗi cộng đồng định nghĩa, và nhưng chung quy đều dùng ba cú pháp này, và kèm theo các nguyên tắc:
Quy tắc đặt tên (naming convention)
Tên lớp thì đặt theo PascalCase
Tên biến, tên hàm đặt theo camelCasehoặc snake_case
Hằng số đặt theo UPPER_CASE, vd: CLICK_COUNTER
Tên biến, tên lớp thường là danh từ, cụm danh từ hoặc tính từ: UserModel, userName, downloadCounter, isDownloaded
Tên hàm thường bắt đầu bằng động từ: getUserName, setUserModel, increaseDownloadCounter
Tên thì phải có nghĩa, và KHÔNG ĐƯỢC đặt tên kiểu viết tắt (dlCounter, uName, idl, a, và a1, doFA)
Tránh đặt các tên quá chung chung, tối nghĩa: top, best, doIncrease, getAll
Đặt tên cần searchable, tức là search được cái tên đó .
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, Thí 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ữ
Một hàm chỉ có duy nhất 1 lý do để thay đổi, trong trường hợp chính đáng, làm nhiều hơn 1 việc cũng được phép, Tuy vậy tên hàm phải nói rõ điều này, vd: increaseDownloadCounterAndSaveToDatabase
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á 120 ký tự
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 mở màn ở cùng cột với đoạn lệnh cùng cấp ở trên .
Comment
“Code never lies, but sometime comment does” – Code thì không bao giờ nói dối, chứ comment thì đôi khi có đấy.
Xem thêm: Co-founder là gì vậy ? Sự khác nhau giữa Founder và Co-founder
Hạn chế dùng comment để giải thích code, thay vào đó hãy cải thiện đoạn code (Clean 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…
Happy coding !