Tài liệu chƣơng trình

Một phần của tài liệu Bài giảng công nghệ phần mềm phần 2 đh sư phạm kỹ thuật nam định (Trang 61 - 62)

- Biến cố 0: Khởi động màn hình

6.2.1. Tài liệu chƣơng trình

Tài liệu chƣơng trình đƣợc hiểu là tài liệu bên trong của chƣơng trình gốc. Nó bắt đầu với việc chọn lựa các tên gọi định danh, tiếp đến là vị trí và thành phần của việc chú thích, và kết luận với cách tổ chức trực quan của chƣơng trình.

Việc lựa chọn các tên gọi định danh có nghĩa chính là điều chủ chốt cho việc hiểu chƣơng trình. Những ngôn ngữ giới hạn tên biến hay nhãn chỉ có trong vài ký tự nên tự nó đã mang nghĩa mơ hồ. Nhƣng ý nghĩa thông thƣờng phải đƣợc áp dụng khi tên gọi đã đƣợc chọn, các tên gọi dài không cần thiết đôi lúc có thể đƣa ra tiềm năng lỗi. Các nghiên cứu đã chỉ ra rằng cho dù một chƣơng trình nhỏ thì một tên gọi có nghĩa cũng làm tăng tính dễ hiểu. Theo ngôn từ của mô hình cú pháp/ngữ nghĩa, tên có ý

nghĩa làm "đơn giản hoá việc chuyển đổi từ cú pháp chƣơng trình sang cấu trúc ngữ nghĩa bên trong".

Các chú thích mô tả đƣợc nhúng vào bên trong thân của chƣơng trình gốc và đƣợc dùng để mô tả cho các hàm xử lý. Lời chú thích nên đƣa ra một điều gì đó phụ trợ, không chỉ là lời diễn giải chƣơng trình. Định dạng cho lời chú thích gồm:

- Một phát biểu về mục đích chỉ rõ chức năng module. - Mô tả giao diện bao gồm:

+ Mẫu lời gọi,

+ Mô tả về mọi đối số,

+ Danh sách tất cả các module thuộc cấp.

- Thảo luận về dữ liệu thích hợp nhƣ các biến quan trọng và những hạn chế và giới hạn về cách dùng chúng, và các thông tin quan trọng khác.

- Lịch sử phát triển bao gồm:

+ Tên ngƣời thiết kế module (tác giả),

+ Tên ngƣời xét duyệt (kiểm toán) và ngày tháng, + Ngày tháng sửa đổi và mô tả sửa đổi,

Một phần của tài liệu Bài giảng công nghệ phần mềm phần 2 đh sư phạm kỹ thuật nam định (Trang 61 - 62)

Tải bản đầy đủ (PDF)

(154 trang)