Các comments chương trình và docstrings Python (phần 2)

Các comments chương trình và docstrings Python (tiếp tục)

Trong một chương trình, tài liệu hướng dẫn tốt có thể là quan trọng như code thực thi. Lí tưởng là, code chương
trình là tự hướng dẫn, nên một người đọc con người có thể hiểu nó ngay lập tức. Tuy nhiên, một chương trình thường
được đọc bởi con người người không phải là tác giả của nó, và thậm chí các tác giả thấy code của bản thân họ
khó để đọc sau hàng tháng không thấy nó. Mẹo là tránh hướng dẫn code cái có một ý nghĩa rõ ràng, nhưng hỗ trợ
người đọc khi code một mình có thể không cung cấp đủ hiểu. Với kết luận này trong đầu, nó là ý tưởng tốt để làm
cái sau:
1. Bắt đầu một chương trình với một phát biểu về mục đích của nó và thông tin khác cái sẽ giúp định hướng một
lập trình viên được gọi để điều chỉnh chương trình tại một vài ngày tháng trong tương lai.
2. Đi kèm định nghĩa biến với một comment cái giải thích mục đích của biến.
3. Đi trước các phân đoạn code chính với các comments ngắn cái giải thích mục đích của chúng. Chương trình case
study trình bày ở trên trong học phần này làm cái này.
4. Bao gồm các comments để giải thích làm việc của các phần code mẹo hay phức tạp.

Chia sẻ