quy ước đặt tên
Trong một hội thảo gần đây, người hướng dẫn bootcamp Alex Baransky đã chia sẻ một số phương pháp hay nhất để viết mã Python để dễ đọc hơn. Thông qua loạt bài viết này, chúng tôi sẽ tóm tắt và cung cấp cho bạn một vài ví dụ về những phương pháp hay nhất đó để giúp bạn viết mã Python đẹp hơn, mang lại lợi ích cho những người có thể đọc và sử dụng mã của bạn trong tương lai, bao gồm cả chính bạn
Python là một ngôn ngữ lập trình hướng đối tượng. Điều này có nghĩa là bạn sẽ tạo, đặt tên và sử dụng tất cả các loại đối tượng trong bất kỳ dự án Python cụ thể nào. Quy ước đặt tên là các quy tắc chung để đặt tên cho các đối tượng mà bạn tạo. Hiểu các quy ước này là bước đầu tiên để giữ cho mã của bạn có thể đọc được cho bạn và đồng đội của bạn.
Thông qua các khóa đào tạo và khóa học, chúng tôi chia sẻ với học sinh rằng có rất nhiều cách để gọi tên đồ vật, một số cách gọi tên đồ vật tốt hơn những cách khác. Hiểu được sự khác biệt giữa tốt và tuyệt vời là cách để gây ấn tượng với nhà tuyển dụng và đồng nghiệp tương lai. Trong bài viết này, chúng tôi sẽ chia sẻ các phương pháp hay nhất về quy ước đặt tên mà bạn có thể làm theo và áp dụng khi viết mã Python của mình
Quy ước đặt tên cơ bản
Hãy bắt đầu với các tùy chọn phổ biến nhất để đặt tên đối tượng trong Python. Sau đây là những cách đặt tên cơ bản.
- chữ thường
- Thường được sử dụng cho các biến cục bộ trong các hàm, chẳng hạn như x hoặc i
- Chữ hoa đơn
- Thường dùng để đặt tên cho ma trận
- chữ thường
- Quy ước đặt tên phổ biến nhất cho nhiều loại đối tượng nhất
- Từ viết thường với dấu gạch dưới
- Sử dụng tương tự như Chữ thường, nhưng đối với các tên phức tạp hơn
- chữ hoa
- Được sử dụng cho các biến tĩnh một từ
- Từ viết hoa với dấu gạch dưới
- Được sử dụng cho các biến tĩnh nhiều từ
- Các từ viết hoa [còn gọi là CapWords hoặc CamelCase]
- Đây là nơi mỗi từ được viết hoa và không có dấu cách hoặc dấu gạch dưới giữa chúng
- Được sử dụng để đặt tên cho các lớp [ngay cả khi tên chỉ là một từ viết hoa]
- trường hợp hỗn hợp
- Đây là nơi bạn bắt đầu với một từ viết thường, theo sau là mọi từ khác được viết hoa
- Quy ước này chủ yếu được sử dụng trong Java và ít hơn trong Python
Mỗi tùy chọn này có các trường hợp sử dụng khác nhau. Chúng không chỉ mang tính thẩm mỹ mà mỗi tùy chọn còn giúp bạn tạo các đối tượng có ý nghĩa trong mã của mình.
Những cái tên cần tránh
Cũng như có những điều bạn nên làm, có những điều bạn không nên. Đây là những quy ước bạn sẽ muốn tránh khi viết mã Python.
- Chữ thường “el” – thay vào đó, hãy sử dụng chữ in hoa “L”
- Chữ hoa “oh” – “O”
- Chữ hoa “mắt” – “tôi”
Chúng tôi tránh những tên đó vì trong một số phông chữ, chúng không thể phân biệt được với các số “1” và “0”, điều này khiến người dùng khó hiểu chuyện gì đang xảy ra
Bạn cũng nên tránh sử dụng các từ khóa Python và tên lớp/hàm dựng sẵn cho tên biến của mình. Ví dụ: các từ như “max”, “sum”, “class” và “list” là những từ đã tồn tại trong bất kỳ môi trường Python nào. Do đó, sử dụng chúng cho mục đích khác ngoài chức năng của chúng có thể khiến mọi thứ trở nên lộn xộn và khó hiểu.
Mô-đun và Gói
Mô-đun là tập hợp các chức năng dựng sẵn và các đối tượng khác được sử dụng để thực hiện các tác vụ nhất định. Các mô-đun nên có tên ngắn, viết thường. Dấu gạch dưới có thể được sử dụng trong tên mô-đun nếu nó cải thiện khả năng đọc [như đối với tên có nhiều từ].
Các gói giống như các thư mục chứa các mô-đun và các đối tượng khác. Các gói Python phải tuân theo cùng một quy ước, mặc dù việc sử dụng dấu gạch dưới trong tên gói không được khuyến khích.
Biến và Hàm
Bạn có biết sự khác biệt giữa hàm và phương thức không? Để hiểu sự khác biệt, hãy nghĩ về mối quan hệ hình vuông-hình chữ nhật. một phương thức là một hàm, nhưng không phải tất cả các hàm đều là phương thức. Một phương thức là một loại chức năng đặc biệt thuộc về một lớp. Chỉ các đối tượng thuộc loại lớp đó mới có thể sử dụng các chức năng đặc biệt này. Đây là một phần của mô hình hướng đối tượng của Python và có thể giúp cải thiện tổ chức và khả năng đọc mã của chúng tôi. Trong Python, tên của các biến và hàm phải là chữ thường. Các từ riêng lẻ có thể được phân tách bằng dấu gạch dưới khi cần thiết. Điều này sẽ cải thiện khả năng đọc trong mã của bạn. Tên phương thức phải tuân theo các quy ước giống như tên hàm.
Dưới đây là một vài phương pháp hay nhất để tuân theo khi đặt tên cho các biến và hàm của bạn
- Các hằng số phải được thể hiện bằng tất cả các chữ in hoa và được phân tách bằng dấu gạch dưới khi cần thiết
- Sử dụng các tên đại diện cho ý nghĩa của đối tượng thay vì các tên đơn, vô nghĩa
- Tên i, j và k nên được dành riêng để biểu thị các giá trị chỉ mục
Hiểu và áp dụng những phương pháp hay nhất này là một cách tuyệt vời để trau dồi kỹ năng mã hóa của bạn. Viết mã đẹp hơn sẽ không chỉ gây ấn tượng với các đồng nghiệp hiện tại của bạn mà còn giúp bạn xây dựng thói quen viết mã tốt hơn để có thể thu hút sự chú ý của các nhà tuyển dụng trong tương lai.
Sẵn sàng để nâng cao kỹ năng lập trình của bạn? .