Tránh những lỗi với những nhận xét hay - những người có đầu

Rất nhiều người bỏ ý kiến ​​như là một bài tập được thiết kế để lãng phí thời gian. Nhưng ý kiến ​​thực sự là vô giá trong việc giúp bạn nhớ tại sao bạn đã làm một cái gì đó theo một cách nhất định và để tránh những kỹ thuật đã không làm việc trong quá khứ. Tuy nhiên, ngoài các tài liệu chung, nhận xét có thể giúp bạn tránh được những sai lầm.

Sau đây là một số lợi ích mà bạn nhận được từ những nhận xét tốt:

• Các nhận xét có thể ghi lại các kỹ thuật đã hoặc chưa từng làm việc trong quá khứ.

• Bạn có thể sử dụng các ý kiến ​​như một phương tiện để nói cho ai đó biết mục đích của một kịch bản, chức năng hoặc phương pháp - làm giảm khả năng sử dụng sai mã cho một nhu cầu cụ thể.

• Một nhận xét tốt cho biết tại sao một cái gì đó được thực hiện theo cách nào đó, giúp đảm bảo rằng các thay đổi mã không gây ra lỗi.

• Ý kiến ​​đầy đủ có nghĩa là ghi lại đầu vào và đầu ra để mọi người biết cách tương tác với kịch bản, chức năng hoặc phương pháp.

• Biết được ai để liên lạc về một vấn đề cụ thể là một hàng phòng vệ đầu tiên chống lại sai sót vì người khởi tạo có thể nói với ai đó cách tránh những vấn đề.

• Tài liệu về môi trường trong đó mã được thiết kế để hoạt động sẽ giúp bạn hiểu được khi nào lỗi là do cập nhật phần mềm khác (chứ không phải là kịch bản, chức năng hoặc phương pháp).

Chính sách tốt nhất là tránh lỗi bất cứ khi nào bạn có thể. Tránh lỗi là luôn luôn ít tốn kém hơn so với phục hồi từ một lỗi. Tuy nhiên, lỗi tốn kém nhất của tất cả là một trong đó là gây tử vong và gây ra các ứng dụng để sụp đổ. Khi ứng dụng sụp đổ, mọi người mất dữ liệu và tổ chức mất khách hàng. Tài liệu thích hợp giúp mọi người hiểu mã của bạn tốt hơn và tránh những sai lầm trước khi chúng xảy ra (hoặc thậm chí trước khi ai đó có thể nghĩ ra cách để làm cho lỗi ở nơi đầu tiên).

Nhận xét tốt nhất trên thế giới không thể ngăn tất cả các lỗi. Một số lỗi đơn giản xảy ra, và bạn không thể làm gì với chúng. Ví dụ, bạn không thể tránh được một lỗi xảy ra như là kết quả của một sét đánh (lỗi dữ liệu được giới thiệu bởi dòng điện gây ra vào một kết nối mạng). Đôi khi trục trặc phần cứng và phần mềm của bên thứ ba mà MATLAB sử dụng để thực hiện các tác vụ cũng có thể chứa lỗi. Nhiều nguồn lỗi nằm ngoài tầm kiểm soát của bạn, nhưng sử dụng nhận xét hiệu quả sẽ giúp bạn giảm được số lỗi bạn có thể kiểm soát.