7 Mẹo Để Tạo Mã Khoa Học Dữ Liệu Có Thể Đọc Được

Liu

7-meo-de-tao-ma-khoa-hoc-du-lieu-co-the-doc-duoc

Khả năng viết mã có thể đọc được là thứ mà các nhà phát triển gọi là một loại hình nghệ thuật. Mặc dù tôi đồng ý một phần với nhận định đó, viết mã, đặc biệt là mã có thể đọc được, là một kỹ năng có thể được phát triển.

Cách duy nhất để cải thiện khả năng đọc mã của bạn là thực hành viết mã chất lượng hơn. Do đó, tôi khuyên bạn nên đọc mã được viết bởi các nhà phát triển khác được biết đến với việc viết mã chất lượng cao.

Nói chung, mã có thể đọc được là một kết quả thiết yếu càng trở nên quan trọng hơn khi mã của bạn càng phức tạp. Đặc biệt, trong khoa học dữ liệu, việc viết mã có thể đọc được là cực kỳ quan trọng vì các ứng dụng khoa học dữ liệu có thể khá khó hiểu, do đó, độ phức tạp tăng thêm do mã được viết không tốt là điều không nên.

Tôi cho rằng bạn đồng ý rằng viết mã có thể đọc được là điều cần thiết. Tuy nhiên, làm cách nào để làm cho mã của tôi dễ đọc hơn?

Trong bài viết này, chúng ta sẽ xem qua một số bước mà bạn có thể thực hiện để tạo mã chất lượng cao, dễ đọc.

Có một cấu trúc trong đầu trước khi bạn bắt đầu viết mã

Trước khi bạn mở trình soạn thảo của mình và bắt đầu viết mã theo cách của mình để giải quyết vấn đề, hãy thử lập kế hoạch cấu trúc mã của bạn. Tạo một cấu trúc, càng chi tiết càng tốt, về các biến, hàm, lớp và mô-đun của bạn và cách tất cả chúng kết nối để giải quyết vấn đề.

Làm điều đó sẽ tiết kiệm rất nhiều thời gian sau này khi bạn triển khai mã, mở rộng và triển khai mã. Tôi khuyên bạn nên thêm cấu trúc đó vào tài liệu về mã của mình hoặc cung cấp mã đó trên GitHub nếu bạn định biến mã của mình thành mã nguồn mở.

Đặt tên cho các biến của bạn theo cách mô tả

Tôi biết đôi khi tất cả chúng ta đều muốn đặt tên cho các biến của mình là X, Y và Z. Nhưng sau đó, chúng ta lại bối rối khi đọc mã của mình nhiều tháng sau đó, cố gắng tìm ra chính xác những gì được lưu trữ trong biến X! Đặt tên cho các tên mô tả biến của bạn sẽ không chỉ giúp người lạ đọc mã của bạn mà còn giúp bạn đọc mã trong tương lai.

Khi đặt tên cho các biến của bạn, hãy đặt tên chính xác thay vì tên ngắn. Ví dụ: nếu bạn đang tính giá trị trung bình của một danh sách các giá trị, thì đừng đặt tên biến là ave hoặc av; đôi khi, như Average_height hoặc Average_time. Ngày nay, nhiều trình chỉnh sửa mã cung cấp tính năng tự động hoàn thành, vì vậy việc sử dụng tên dài hơn sẽ không làm cho quá trình viết mã của bạn chậm hơn.

Ngoài ra, hãy giữ tên của biến liên quan đến nguồn đó nếu mã của bạn triển khai thuật toán được giới thiệu trong một bài báo hoặc cuốn sách cụ thể. Hãy nhớ bao gồm nguồn đó ở đầu tệp mã của bạn.

Sử dụng chức năng một cách khôn ngoan

Các chức năng có thể là một công cụ tuyệt vời để có một mã ngắn gọn, có tổ chức. Đó là, nếu được sử dụng đúng cách. Sử dụng các hàm cho các tác vụ có thể được đóng gói thành một hàm, chẳng hạn như áp dụng một thao tác trên các điểm dữ liệu khác nhau hoặc triển khai một bước thuật toán. Khi bạn đặt tên cho các hàm của mình, hãy sử dụng logic giống như chúng tôi đã trình bày khi đặt tên cho các biến của bạn.

Thu thập các chức năng có chức năng liên quan trong một tệp mã và biến nó thành một mô-đun nếu có thể. Điều đó làm cho việc tìm kiếm, mở rộng và sử dụng chức năng trở nên dễ dàng hơn.

Cố gắng làm rõ loại thuộc tính cụ thể của hàm và làm cho hàm của bạn an toàn và có thể mở rộng.

Mục tiêu tài liệu rõ ràng và súc tích

Ghi lại mã của bạn là một bước thiết yếu, cho dù đó là tài liệu hoàn chỉnh hay trong mã (docstrings). Chuỗi tài liệu là các chuỗi ở đầu tệp mã, sau định nghĩa hàm/lớp, cho người đọc biết mục đích của mã/hàm hoặc lớp.

Docstrings có nghĩa là một gợi ý ngắn về mã của bạn là gì và nó hoạt động như thế nào. Ví dụ: Khi được sử dụng ở đầu hàm (ngay bên dưới tiêu đề hàm), nó phải bao gồm các loại thuộc tính dự kiến và vai trò của chúng trong hàm, đầu ra của hàm và một hoặc hai câu về cách đầu ra đó. tính toán.

Trong trường hợp của một lớp, chuỗi tài liệu phải bao gồm các thuộc tính và phương thức của lớp và cách chúng có thể được sử dụng.

Đừng phát minh lại Wheel (trừ khi bạn có thể làm tốt hơn)

Nếu chức năng bạn cần đã được triển khai bởi gói được hỗ trợ hoặc nhà phát triển bên thứ ba, hãy sử dụng chức năng đó thay vì triển khai toàn bộ. Khi bạn sử dụng một gói, hãy đảm bảo rằng bạn biết tất cả các chức năng mà gói bao gồm để bạn tiết kiệm thời gian cố gắng triển khai thứ gì đó mà bạn có thể sử dụng.

Một vài tình huống mà tôi khuyên bạn nên tự triển khai một chức năng là khi bạn mới lập trình và đang cố gắng tìm hiểu cách mọi thứ hoạt động hoặc nếu bạn có thể triển khai một chức năng tốt hơn với độ phức tạp ít hơn. Mặt khác, sẽ đơn giản hơn cho bạn và những người khác sử dụng mã của bạn để sử dụng những gì đã được triển khai.

Hướng tới những bước đơn giản, dài hơn là những bước ngắn, phức tạp

Khi bạn cố gắng thực hiện một ý tưởng được trình bày trong một bài báo hoặc một cuốn sách hoặc một thuật toán, hãy nhắm đến các bước rõ ràng thay vì cố gắng nhóm nhiều bước lại với nhau để có mã ngắn hơn.

Đúng vậy, đoạn mã ngắn hơn có thể cho thấy bạn sử dụng thành ngữ của một ngôn ngữ lập trình tốt như thế nào. Tuy nhiên, nó cũng có thể làm cho mã của bạn trở nên phức tạp không cần thiết. Phức tạp để đọc, kiểm tra, gỡ lỗi và mở rộng. Đặc biệt là khi bản thân thuật toán bạn đang triển khai đã phức tạp, việc thêm lớp phức tạp bổ sung này bằng cách nhóm một số bước lại với nhau sẽ dẫn đến mã không linh hoạt lắm.

Nhất quán

Tính nhất quán là tuyệt vời cho khả năng đọc mã. Khi lập kế hoạch cấu trúc mã của bạn, hãy quyết định một phong cách để sử dụng xuyên suốt mã của bạn. Điều đó bao gồm việc xác định một hệ thống để đặt tên cho các biến, hàm và lớp của bạn. Cách bạn sẽ sử dụng nhận xét, giải quyết các bước toán học khác nhau trong thuật toán này, điều chỉnh mã của bạn và sử dụng các gói hiện có.

Theo dõi và hiểu mã của bạn sẽ nhanh hơn nhiều khi bạn có một phong cách và mẫu nhất quán.

Kết luận

Một trong những điều không thể tránh khỏi khi trở thành nhà khoa học dữ liệu là sử dụng mã do người khác viết. Và mặc dù việc đọc và hiểu mã do người khác viết sẽ luôn là một nhiệm vụ tốn thời gian, nhưng bạn có thể thực hiện theo một số bước để làm cho mã của mình dễ theo dõi và sử dụng hơn cho những người sắp sử dụng mã đó.

Mặc dù các mẹo được đề cập trong bài viết này có thể được sử dụng bởi bất kỳ ai viết mã chứ không chỉ các nhà khoa học dữ liệu, nhưng theo tôi, điều cực kỳ quan trọng đối với các nhà khoa học dữ liệu là tạo ra mã có thể đọc được để khắc phục một số khó khăn đã tồn tại do toán học. đằng sau hầu hết các thuật toán khoa học dữ liệu.

Vì vậy, nếu bạn muốn bắt đầu viết mã tốt hơn, dễ đọc hơn, bài viết này sẽ là một nơi tốt để bắt đầu. Hãy nhớ rằng, viết mã tốt hơn là một kỹ năng; giống như bất kỳ kỹ năng nào khác, nó sẽ cải thiện khi luyện tập.

Copyright Disclaimer:

This site does not store any files on its server. We only index and link to content provided by other sites. Please contact the content providers to delete copyright contents if any and email us, we'll remove relevant links or contents immediately.

Tuyên bố miễn trừ bản quyền:

Trang web này không lưu trữ bất kỳ tệp nào trên máy chủ của nó. Chúng tôi chỉ lập chỉ mục và liên kết đến nội dung được cung cấp bởi các trang web khác. Vui lòng liên hệ với các nhà cung cấp nội dung để xóa nội dung bản quyền nếu có và gửi email cho chúng tôi, chúng tôi sẽ xóa các liên kết hoặc nội dung có liên quan ngay lập tức.